Skip to main content
POST
Create project

Authorizations

Authorization
string
header
required

Your ara_ API key from Settings > Ara API. Keys are capability-scoped: run, mcp:read, mcp:write, secrets:read, secrets:write, sessions:read, sessions:debug, knowledge:read, memory:read, memory:write, skills:read, skills:write, repos:read, repos:write, reviews:read, reviews:write, deployment:read, analytics:read, org:read, org:write, attachments:read, attachments:write, guardrails:read, guardrails:write, automations:read, automations:write, agent_auth:read. mcp:write manages MCP server configuration only; it does not authorize remote MCP-tool execution. sessions:debug is privileged: it expands diagnostic session events only for organization owners/admins.

Path Parameters

orgId
string
required

Organization id or slug. Resolve it with GET /v3/self.

Body

application/json

Create a project. An explicit slug is unique within the workspace; a collision returns 409 rather than creating a suffixed duplicate.

name
string
required
Required string length: 1 - 120
slug
string
Maximum string length: 120
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
description
string | null
Maximum string length: 2000
visibility
enum<string>
default:workspace
Available options:
workspace,
private
kind
enum<string>
default:local
Available options:
local,
remote
cloud_enabled
boolean
default:true
resources
object[]
Maximum array length: 100
source_folders
(string | object)[]
Maximum array length: 100
Required string length: 1 - 4096
preferred_dir
string | null
Maximum string length: 4096
project_md
string
note
string | null

Response

Created project.

An existing, accessible project and its session resources.

id
string<uuid>
required

Pass this id as project_id when creating or listing sessions.

name
string
required
slug
string
required
description
string | null
required
kind
enum<string>
required
Available options:
local,
remote
cloud_enabled
boolean
required

Whether this Project permits the default cloud session target. When false, select a compatible Device target explicitly.

visibility
enum<string>
required
Available options:
workspace,
private
resources
object[]
required