> ## Documentation Index
> Fetch the complete documentation index at: https://ara-90a60a07.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Read workspace readiness
> A read-only preflight for the credential's pinned workspace. Available to any valid public API key or OAuth grant; each resource check requires its existing capability and a write-capable workspace role (owner, admin or member). Missing capabilities or role return unknown without reading that resource. Uses recorded GitHub state, not a provider login or repository authorization test. Personal Devices are optional for cloud work. Does not reserve credits, charge, refresh connections, repair resources, enroll a Device or start a Session/Loop. Ready applies only to the check described, never guarantees a later write. Existing /self is unchanged.
Auth: any valid API key (no scope)
## OpenAPI
````yaml /openapi.json get /v3/self/readiness
openapi: 3.1.0
info:
title: Reason API
version: 3.0.0
description: >-
The Reason HTTP API. Drive cloud software-engineering agents: open sessions
against your repositories, stream their work, and manage the secrets,
skills, and automations they run with.
Authenticate with a Reason API key sent as a bearer token. New keys use
`reason_`; legacy `ara_` keys remain accepted. Every resource is scoped to
an organization; resolve your `org_id` once with `GET /v3/self`.
servers:
- url: https://api.reasonmachines.com
security:
- reasonApiKey: []
tags:
- name: Account
description: Verify a key and resolve the organization it belongs to.
- name: Reasons
description: >-
Start here. A Reason is the long-running agent a person keeps: their main
Reason and named ones, each with its own instructions, default model and
repositories, conversation, Loops and Sessions. Give a Reason work by
messaging it (sendReasonMessage) and read its replies with
listReasonMessages.
- name: Loops
description: >-
Standing work a Reason does, woken by a schedule or an event: a webhook, a
GitHub event or a Slack message. Each wake opens or continues a Session of
the Reason; webhook events that share a correlation key continue one
Session.
- name: Memory
description: >-
What Reasons remember across Sessions. Each Session starts by reading
MEMORY.md (a short index) and the list of topic notes, and reads a note
when its topic comes up. `personal` memory belongs to one person (the API
key's owner) and only their Sessions read it; `team` memory belongs to the
Workspace and every member's Sessions read it. memory:read lists, reads
and searches; memory:write writes and deletes, in team memory only for a
Workspace owner or admin.
- name: Sessions
description: >-
A Session is one run of work inside a Reason: every Reason message and
Loop wake runs in one, and createSession starts one directly for a single
unattended task with a pass/fail outcome. Its transcript, events, result
and pull request are read here.
- name: Skills
description: >-
Reusable instruction bundles Reason selects semantically from their
descriptions for matching agent tasks.
- name: Secrets
description: >-
Encrypted credentials injected into the agent's sandbox. Write-only:
values can be set but never read back.
- name: Attachments
description: >-
Files uploaded to the organization and shared with sessions, downloaded
via short-lived signed URLs.
- name: Repositories
description: Connected repositories, their indexing state, and generated wikis.
- name: Git Connections
description: Linked source-control accounts and the repositories they expose.
- name: Machines
description: >-
Named Workspace queues served by headless workers. Sessions target a
Machine by name and wait for a free worker; more workers serve more
Sessions concurrently.
- name: Devices
description: >-
Owned Mac and headless Device identity, bounded enrollment and root
grants.
- name: Cloud Access
description: >-
Keyless cloud sign-in for sessions: Reason's OIDC issuer facts and the
AWS, Google Cloud and Azure connections a workspace trusts, including
which run triggers each one signs in.
- name: MCP Servers
description: >-
Org-level Model Context Protocol servers exposed to the agent. Secret
values are write-only.
- name: Change Request Reviews
description: >-
Automated senior-engineer reviews posted on pull requests and merge
requests.
- name: Consumption
description: 'Billing-aligned usage: daily consumption and billing cycles.'
- name: Metrics
description: Aggregate analytics over sessions, change requests, and usage.
- name: Audit Logs
description: An append-only record of changes made within the organization.
- name: Organizations
description: The top-level tenant. Create, read, update, and delete organizations.
- name: Members
description: People in an organization and their pending invites.
- name: Roles
description: Role assignments that govern what each member can do.
- name: Settings
description: 'Organization configuration: namespaced settings and the run tag policy.'
- name: Provider credentials
description: >-
Configure Bring-Your-Own-Key (BYOK) API keys and subscription credentials
for model providers. Secret values are write-only.
- name: Feedback
description: Report problems with the API or these docs to the Reason team.
- name: Projects
description: >-
Deprecated: a project is a Reason with the same id. Use the Reasons
operations; these remain for existing clients.
- name: Automations
description: >-
The older form of Loops. Prefer the Loops under a Reason (listReasonLoops,
createReasonLoop), which take every wake: schedule, webhook, GitHub,
Slack. Use these for what Loops do not carry yet: a run's MCP and app
tools, and automations not filed under a Reason.
paths:
/v3/self/readiness:
get:
tags:
- Account
summary: Read workspace readiness
description: >-
A read-only preflight for the credential's pinned workspace. Available
to any valid public API key or OAuth grant; each resource check requires
its existing capability and a write-capable workspace role (owner, admin
or member). Missing capabilities or role return unknown without reading
that resource. Uses recorded GitHub state, not a provider login or
repository authorization test. Personal Devices are optional for cloud
work. Does not reserve credits, charge, refresh connections, repair
resources, enroll a Device or start a Session/Loop. Ready applies only
to the check described, never guarantees a later write. Existing /self
is unchanged.
Auth: any valid API key (no scope)
operationId: getSelfReadiness
responses:
'200':
description: Readiness snapshot with per-check limits and actions.
content:
application/json:
schema:
$ref: '#/components/schemas/SelfReadiness'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/RateLimited'
security:
- reasonApiKey: []
components:
schemas:
SelfReadiness:
type: object
properties:
checked_at:
type: string
resource_mode:
type: string
enum:
- legacy-personal
- consolidated
access:
type: object
properties:
granted_scopes:
type: array
items:
type: string
workspace_role:
type: string
write_capable_role:
type: boolean
privileged_role:
type: boolean
writable_secret_scopes:
type: array
items:
type: string
enum:
- user
- organization
description: >-
Scopes this credential and current role may write through the
secrets API. Repository scope is a deprecated alias of
organization. Individual secret-name and operation validation
still apply.
secret_defaults:
type: object
properties:
list:
type: string
enum:
- user
- organization
create:
type: string
enum:
- user
- organization
delete:
type: string
enum:
- user
- organization
required:
- list
- create
- delete
run:
type: object
properties:
status:
type: string
enum:
- ready
- blocked
- unknown
- not_applicable
description: >-
Ready only for the explicitly described check, not a
guarantee that a future operation will be admitted.
detail:
type: string
actions:
type: array
items:
type: object
properties:
code:
type: string
description: Stable prerequisite or observation code.
actor:
type: string
enum:
- caller
- workspace_admin
- device_owner
- github_admin
action:
type: string
description: >-
The human action that resolves the prerequisite or
completes the check. This read never performs it.
required:
- code
- actor
- action
required:
- status
- detail
- actions
loops:
type: object
properties:
status:
type: string
enum:
- ready
- blocked
- unknown
- not_applicable
description: >-
Ready only for the explicitly described check, not a
guarantee that a future operation will be admitted.
detail:
type: string
actions:
type: array
items:
type: object
properties:
code:
type: string
description: Stable prerequisite or observation code.
actor:
type: string
enum:
- caller
- workspace_admin
- device_owner
- github_admin
action:
type: string
description: >-
The human action that resolves the prerequisite or
completes the check. This read never performs it.
required:
- code
- actor
- action
required:
- status
- detail
- actions
required:
- granted_scopes
- workspace_role
- write_capable_role
- privileged_role
- writable_secret_scopes
- secret_defaults
- run
- loops
funding:
type: object
properties:
status:
type: string
enum:
- ready
- blocked
- unknown
- not_applicable
description: >-
Ready only for the explicitly described check, not a guarantee
that a future operation will be admitted.
detail:
type: string
actions:
type: array
items:
type: object
properties:
code:
type: string
description: Stable prerequisite or observation code.
actor:
type: string
enum:
- caller
- workspace_admin
- device_owner
- github_admin
action:
type: string
description: >-
The human action that resolves the prerequisite or
completes the check. This read never performs it.
required:
- code
- actor
- action
required:
- status
- detail
- actions
description: >-
Read-only API/Loop funding preflight, not a model,
provider-capacity, seat, spend-limit or compute reservation.
github:
type: object
properties:
status:
type: string
enum:
- ready
- blocked
- unknown
- not_applicable
description: >-
Ready only for the explicitly described check, not a guarantee
that a future operation will be admitted.
detail:
type: string
actions:
type: array
items:
type: object
properties:
code:
type: string
description: Stable prerequisite or observation code.
actor:
type: string
enum:
- caller
- workspace_admin
- device_owner
- github_admin
action:
type: string
description: >-
The human action that resolves the prerequisite or
completes the check. This read never performs it.
required:
- code
- actor
- action
required:
- status
- detail
- actions
description: >-
Recorded workspace installations and this caller's own connection
only. Target repository permissions must be verified separately; no
connection is refreshed or repaired.
devices:
type: object
properties:
status:
type: string
enum:
- ready
- blocked
- unknown
- not_applicable
description: >-
Ready only for the explicitly described check, not a guarantee
that a future operation will be admitted.
detail:
type: string
actions:
type: array
items:
type: object
properties:
code:
type: string
description: Stable prerequisite or observation code.
actor:
type: string
enum:
- caller
- workspace_admin
- device_owner
- github_admin
action:
type: string
description: >-
The human action that resolves the prerequisite or
completes the check. This read never performs it.
required:
- code
- actor
- action
required:
- status
- detail
- actions
description: >-
Only this caller's personal Devices, not teammates' inventory or
cloud-computer capacity. Optional for cloud work.
required:
- checked_at
- resource_mode
- access
- funding
- github
- devices
Error:
type: object
properties:
error:
oneOf:
- type: string
- type: object
required:
- type
- message
properties:
type:
type: string
message:
type: string
request_id:
type:
- string
- 'null'
message:
type: string
required_scope:
type: string
description: >-
The capability required when the request was denied for a missing
scope.
responses:
Unauthorized:
description: Missing, invalid, or expired key.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: missing_bearer
message: Authorization required
Forbidden:
description: The key lacks the required scope or role.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: missing_scope
required_scope: sessions:read
RateLimited:
description: >-
Too many requests. Retry after the number of seconds in the
`Retry-After` response header.
headers:
Retry-After:
description: Seconds to wait before retrying.
schema:
type: integer
minimum: 1
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
type: rate_limited
message: This API key exceeded its request-rate limit
securitySchemes:
reasonApiKey:
type: http
scheme: bearer
bearerFormat: 'reason_ (legacy: ara_)'
description: >-
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).
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.