Skip to main content
GET
Get a Reason

Authorizations

Authorization
string
header
required

Your Reason API key from Settings › API keys. 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, network:read, network:write, automations:read, automations:write, agent_auth:read. network:read and network:write are opt-in, excluded from default keys. network:read reads the saved workspace network policy; network:write replaces custom allowed hosts and requires a current organization owner/admin. Legacy project PATCH requests containing network_allowed_hosts also require network:write plus their existing run scope and project management permission; saved project hosts do not affect current session egress. Only owners/admins can mint or manage keys with network:write; keys cannot grant themselves more authority. See /docs/network-policies for replacement semantics and runtime applicability. mcp:write manages MCP server configuration only; it does not authorize remote MCP-tool execution. sessions:read reads sessions, including the assistant, reasoning and tool activity in their events. sessions:debug is privileged: only for organization owners/admins, it expands session events to the full diagnostic projection (diagnostic event kinds, status text and raw event metadata).

Path Parameters

orgId
string
required

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

reasonId
string<uuid>
required

The Reason id, returned as id by listReasons and createReason.

Response

The Reason.

A Reason is the long-running agent a person keeps: their main Reason, or a named one for an area of work. Each has its own conversation, its own Loops (scheduled and triggered work) and the Sessions it starts, which are filed under it. Messaging the Reason is the primary way to give it work: it decides whether to answer, start Sessions or set up Loops.

id
string<uuid>
required

Reason id. Pass it as reasonId to the other Reason tools.

name
string
required

Display name. The main Reason is always called Reason.

user_id
string<uuid>
required

The owner, the only person who can open, rename or archive it.

mine
boolean
required

True when the caller owns this Reason.

visibility
enum<string>
required

workspace: every member sees it in their list; private: only its owner does.

Available options:
workspace,
private
main
boolean
required

True for the person's main Reason, which is always listed and is never renamed or archived.

appearance
object
required

How the Reason's bot avatar looks in the app. Purely visual; it changes nothing the agent does.

instructions
string
required

Plain-text guidance for new Sessions started with this Reason. Blank when unset or when the caller does not own the Reason.

session_id
string | null
required

Its conversation Session once it has been opened, and only on the caller's own Reasons; null otherwise. sendReasonMessage and listReasonMessages reach the conversation of any Reason you can open without it.

default_model
string | null
required

The model a new Session under this Reason starts on when its create names none, by an id listAgentModels returns; null when it uses the workspace's default.

default_reasoning_effort
enum<string> | null
required

The reasoning effort that Session starts at when its create names none; null for the model's default.

Available options:
minimal,
low,
medium,
high,
xhigh,
max,
off
default_repositories
string[] | null
required

The owner/name repositories a new Session under this Reason checks out when its create names none, the first being the Session's own; empty when it has none. Null when the caller cannot start Sessions under this Reason.

audience
enum<string>
required

Who talks to it. personal: only its owner; team: the people it is shared with; customer: a team Reason that people outside the team (customers, in Slack for example) also talk to, whose runs use only what was added to the Reason itself.

Available options:
personal,
team,
customer
created_at
string<date-time>
required
updated_at
string<date-time>
required