Skip to main content
GET
Retrieve a project

Authorizations

Authorization
string
header
required

Your Reason API key from Settings > API. New keys use reason_; legacy ara_ keys remain accepted. 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.

projectId
string<uuid>
required

The project id.

Response

Project and current instructions.

Project metadata and current canonical instructions. Use project_document.revision for instruction updates; revision tracks project metadata separately.

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
archived_at
string | null
required
revision
integer
required
can_edit
boolean
required
resources
object[]
required
project_document
object
required