Skip to content
LogoLogo

Toolang API

Reference for the local Toolang agent HTTP API.

Endpoints

MethodPathTagSummary
GET/api/v0/top/snapshotactivitySnapshot
GET/api/v0/agicsagentList Agent Agics
GET/api/v0/flowsagentList Agent Flows
GET/api/v0/modelsagentList Agent Models
GET/api/v0/profileagentGet Profile
GET/api/v0/prompt-completionsagentList Prompt Completions
GET/api/v0/streamagentStream Agent Events
GET/api/v0/toolsagentList Agent Tools
GET/api/v0/workspacesagentList Agent Workspaces
GET/healthzagentHealth Check
PUT/api/v0/runtime/leases/{client_id}agentRetain Server
POST/api/v0/runtime/promoteagentKeep Server Running
DELETE/api/v0/runtime/leases/{client_id}agentRelease Server
GET/api/v0/capscapsGet Caps Summary
GET/api/v0/promptscapsList Prompts
GET/api/v0/prompts/templatescapsList Prompt Templates
GET/api/v0/prompts/templates/defaultcapsGet Prompt Template
GET/api/v0/prompts/{name}capsGet Prompt
GET/api/v0/psychescapsList Psyches
GET/api/v0/psyches/templatescapsList Psyche Templates
GET/api/v0/psyches/templates/defaultcapsGet Psyche Template
GET/api/v0/psyches/{name}capsGet Psyche
GET/api/v0/servicescapsList Services
GET/api/v0/services/templatescapsList Service Templates
GET/api/v0/services/templates/defaultcapsGet Service Template
GET/api/v0/services/{name}capsGet Service
GET/api/v0/skillscapsList Skills
GET/api/v0/skills/templatescapsList Skill Templates
GET/api/v0/skills/templates/defaultcapsGet Skill Template
GET/api/v0/skills/{name}capsGet Skill
PUT/api/v0/prompts/{name}/authoredcapsUpsert Authored Prompt
PUT/api/v0/prompts/{name}/configuredcapsConfigure Prompt
PUT/api/v0/psyches/{name}/authoredcapsUpsert Authored Psyche
PUT/api/v0/psyches/{name}/configuredcapsConfigure Psyche
PUT/api/v0/services/{name}/authoredcapsUpsert Authored Service
PUT/api/v0/services/{name}/configuredcapsConfigure Service
PUT/api/v0/skills/{name}/authoredcapsUpsert Authored Skill
PUT/api/v0/skills/{name}/configuredcapsConfigure Skill
DELETE/api/v0/prompts/{name}/authoredcapsDelete Authored Prompt
DELETE/api/v0/prompts/{name}/configuredcapsRemove Configured Prompt
DELETE/api/v0/psyches/{name}/authoredcapsDelete Authored Psyche
DELETE/api/v0/psyches/{name}/configuredcapsRemove Configured Psyche
DELETE/api/v0/services/{name}/authoredcapsDelete Authored Service
DELETE/api/v0/services/{name}/configuredcapsRemove Configured Service
DELETE/api/v0/skills/{name}/authoredcapsDelete Authored Skill
DELETE/api/v0/skills/{name}/configuredcapsRemove Configured Skill
GET/api/v0/choreschoresList Chores
GET/api/v0/chores/{chore_id}choresGet Chore
POST/api/v0/choreschoresCreate Chore
POST/api/v0/chores/{chore_id}/cancelchoresCancel Chore
POST/api/v0/chores/{chore_id}/runchoresRun Chore
DELETE/api/v0/chores/{chore_id}choresDelete Chore Definition
PATCH/api/v0/chores/{chore_id}choresUpdate Chore
GET/api/v0/runsrunsList Runs
GET/api/v0/runs/defaultsrunsGet Run Defaults
GET/api/v0/runs/liverunsGet Live Execution Trees
GET/api/v0/runs/{run_id}runsGet Run
GET/api/v0/runs/{run_id}/streamrunsStream Run Events
POST/api/v0/chat/runs/authored/streamrunsExecute Authored Run Stream
POST/api/v0/chat/runs/streamrunsExecute Run Stream
POST/api/v0/chat/runs/{run_id}/rerunrunsRerun Run
POST/api/v0/chat/runs/{run_id}/rerun/streamrunsRerun Authored Run Stream
POST/api/v0/chat/runs/{run_id}/steerrunsSteer Run
POST/api/v0/runs/authored/streamrunsExecute Authored Run Stream
POST/api/v0/runs/input-referencesrunsDiscover Client File Inputs
POST/api/v0/runs/streamrunsExecute Run Stream
POST/api/v0/runs/threadsrunsCreate Execution Thread
POST/api/v0/runs/workdir/resolverunsResolve Run Workdir
POST/api/v0/runs/{run_id}/cancelrunsCancel Run
POST/api/v0/runs/{run_id}/rerunrunsRerun Run
POST/api/v0/runs/{run_id}/rerun/streamrunsRerun Authored Run Stream
POST/api/v0/runs/{run_id}/steerrunsSteer Run
GET/api/v0/threadsthreadsList Threads
GET/api/v0/threads/{thread_id}threadsGet Thread
GET/api/v0/threads/{thread_id}/resultthreadsGet Latest Thread Result
GET/api/v0/threads/{thread_id}/streamthreadsStream Thread Events
POST/api/v0/threadsthreadsCreate Thread
POST/api/v0/threads/{thread_id}/forkthreadsFork Thread
POST/api/v0/threads/{thread_id}/rewindthreadsRewind Thread
GET/api/v0/stats/dailystatsDaily
GET/api/v0/stats/modelsstatsModels
GET/api/v0/stats/recentstatsRecent
GET/api/v0/stats/summarystatsSummary

Activity

Live execution activity.

GET /api/v0/top/snapshot

Snapshot

Parameters:

NameInRequiredTypeDefaultDescription
recentquerynointeger300value >= 1; value <= 900
before_timequerynostring | null
after_idquerynostring | null
completed_atquerynointeger | nullinteger: value >= 0

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonActivitySnapshot
422Validation Errorapplication/jsonHTTPValidationError

Agent

Agent profile, health, and operational update endpoints.

GET /api/v0/agics

List Agent Agics

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonobject

GET /api/v0/flows

List Agent Flows

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonobject

GET /api/v0/models

List Agent Models

Parameters:

NameInRequiredTypeDefaultDescription
queryquerynoarray<string> | null

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonobject
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v0/profile

Get Profile

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonobject

GET /api/v0/prompt-completions

List Prompt Completions

Parameters:

NameInRequiredTypeDefaultDescription
runnablequerynostring | null

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonobject
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v0/stream

Stream Agent Events

Parameters:

NameInRequiredTypeDefaultDescription
afterquerynostring | null

Responses:

StatusDescriptionContent TypeSchema
200Successful Responsetext/event-streamany
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v0/tools

List Agent Tools

Parameters:

NameInRequiredTypeDefaultDescription
queryquerynoarray<string> | null

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonobject
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v0/workspaces

List Agent Workspaces

Parameters:

NameInRequiredTypeDefaultDescription
workdirquerynostring | null

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonWorkspaceInspection
422Validation Errorapplication/jsonHTTPValidationError

GET /healthz

Health Check

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonobject<string, boolean>

PUT /api/v0/runtime/leases/{client_id}

Retain Server

Parameters:

NameInRequiredTypeDefaultDescription
client_idpathyesstring

Request body:

Content TypeRequiredSchema
application/jsonyesRuntimeLaunchRequest

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonRuntimeLifecyclePayload
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v0/runtime/promote

Keep Server Running

Request body:

Content TypeRequiredSchema
application/jsonyesRuntimeLaunchRequest

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonRuntimeLifecyclePayload
422Validation Errorapplication/jsonHTTPValidationError

DELETE /api/v0/runtime/leases/{client_id}

Release Server

Parameters:

NameInRequiredTypeDefaultDescription
client_idpathyesstring

Request body:

Content TypeRequiredSchema
application/jsonyesRuntimeLaunchRequest

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonobject<string, boolean>
422Validation Errorapplication/jsonHTTPValidationError

Caps

Capability inspection and mutation endpoints.

GET /api/v0/caps

Get Caps Summary

Parameters:

NameInRequiredTypeDefaultDescription
queryquerynoarray<string> | null

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonobject
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v0/prompts

List Prompts

Parameters:

NameInRequiredTypeDefaultDescription
queryquerynoarray<string> | null

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonarray<CapInfo>
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v0/prompts/templates

List Prompt Templates

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonarray<object>

GET /api/v0/prompts/templates/default

Get Prompt Template

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonobject

GET /api/v0/prompts/{name}

Get Prompt

Parameters:

NameInRequiredTypeDefaultDescription
namepathyesstring

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonCapDetail
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v0/psyches

List Psyches

Parameters:

NameInRequiredTypeDefaultDescription
queryquerynoarray<string> | null

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonarray<CapInfo>
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v0/psyches/templates

List Psyche Templates

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonarray<object>

GET /api/v0/psyches/templates/default

Get Psyche Template

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonobject

GET /api/v0/psyches/{name}

Get Psyche

Parameters:

NameInRequiredTypeDefaultDescription
namepathyesstring

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonCapDetail
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v0/services

List Services

Parameters:

NameInRequiredTypeDefaultDescription
queryquerynoarray<string> | null

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonarray<CapInfo>
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v0/services/templates

List Service Templates

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonarray<object>

GET /api/v0/services/templates/default

Get Service Template

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonobject

GET /api/v0/services/{name}

Get Service

Parameters:

NameInRequiredTypeDefaultDescription
namepathyesstring

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonCapDetail
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v0/skills

List Skills

Parameters:

NameInRequiredTypeDefaultDescription
queryquerynoarray<string> | null

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonarray<CapInfo>
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v0/skills/templates

List Skill Templates

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonarray<object>

GET /api/v0/skills/templates/default

Get Skill Template

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonobject

GET /api/v0/skills/{name}

Get Skill

Parameters:

NameInRequiredTypeDefaultDescription
namepathyesstring

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonCapDetail
422Validation Errorapplication/jsonHTTPValidationError

PUT /api/v0/prompts/{name}/authored

Upsert Authored Prompt

Parameters:

NameInRequiredTypeDefaultDescription
namepathyesstring

Request body:

Content TypeRequiredSchema
application/jsonyesPutCapRequest

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonCapDetail
422Validation Errorapplication/jsonHTTPValidationError

PUT /api/v0/prompts/{name}/configured

Configure Prompt

Parameters:

NameInRequiredTypeDefaultDescription
namepathyesstring

Request body:

Content TypeRequiredSchema
application/jsonyesConfiguredCapRequest

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonCapDetail
422Validation Errorapplication/jsonHTTPValidationError

PUT /api/v0/psyches/{name}/authored

Upsert Authored Psyche

Parameters:

NameInRequiredTypeDefaultDescription
namepathyesstring

Request body:

Content TypeRequiredSchema
application/jsonyesPutCapRequest

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonCapDetail
422Validation Errorapplication/jsonHTTPValidationError

PUT /api/v0/psyches/{name}/configured

Configure Psyche

Parameters:

NameInRequiredTypeDefaultDescription
namepathyesstring

Request body:

Content TypeRequiredSchema
application/jsonyesConfiguredCapRequest

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonCapDetail
422Validation Errorapplication/jsonHTTPValidationError

PUT /api/v0/services/{name}/authored

Upsert Authored Service

Parameters:

NameInRequiredTypeDefaultDescription
namepathyesstring

Request body:

Content TypeRequiredSchema
application/jsonyesPutCapRequest

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonCapDetail
422Validation Errorapplication/jsonHTTPValidationError

PUT /api/v0/services/{name}/configured

Configure Service

Parameters:

NameInRequiredTypeDefaultDescription
namepathyesstring

Request body:

Content TypeRequiredSchema
application/jsonyesConfiguredCapRequest

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonCapDetail
422Validation Errorapplication/jsonHTTPValidationError

PUT /api/v0/skills/{name}/authored

Upsert Authored Skill

Parameters:

NameInRequiredTypeDefaultDescription
namepathyesstring

Request body:

Content TypeRequiredSchema
application/jsonyesPutCapRequest

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonCapDetail
422Validation Errorapplication/jsonHTTPValidationError

PUT /api/v0/skills/{name}/configured

Configure Skill

Parameters:

NameInRequiredTypeDefaultDescription
namepathyesstring

Request body:

Content TypeRequiredSchema
application/jsonyesConfiguredCapRequest

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonCapDetail
422Validation Errorapplication/jsonHTTPValidationError

DELETE /api/v0/prompts/{name}/authored

Delete Authored Prompt

Parameters:

NameInRequiredTypeDefaultDescription
namepathyesstring
scopequerynohome | root"home"

Responses:

StatusDescriptionContent TypeSchema
204Successful Response
422Validation Errorapplication/jsonHTTPValidationError

DELETE /api/v0/prompts/{name}/configured

Remove Configured Prompt

Parameters:

NameInRequiredTypeDefaultDescription
namepathyesstring
scopequerynohome | root"home"

Responses:

StatusDescriptionContent TypeSchema
204Successful Response
422Validation Errorapplication/jsonHTTPValidationError

DELETE /api/v0/psyches/{name}/authored

Delete Authored Psyche

Parameters:

NameInRequiredTypeDefaultDescription
namepathyesstring
scopequerynohome | root"home"

Responses:

StatusDescriptionContent TypeSchema
204Successful Response
422Validation Errorapplication/jsonHTTPValidationError

DELETE /api/v0/psyches/{name}/configured

Remove Configured Psyche

Parameters:

NameInRequiredTypeDefaultDescription
namepathyesstring
scopequerynohome | root"home"

Responses:

StatusDescriptionContent TypeSchema
204Successful Response
422Validation Errorapplication/jsonHTTPValidationError

DELETE /api/v0/services/{name}/authored

Delete Authored Service

Parameters:

NameInRequiredTypeDefaultDescription
namepathyesstring
scopequerynohome | root"home"

Responses:

StatusDescriptionContent TypeSchema
204Successful Response
422Validation Errorapplication/jsonHTTPValidationError

DELETE /api/v0/services/{name}/configured

Remove Configured Service

Parameters:

NameInRequiredTypeDefaultDescription
namepathyesstring
scopequerynohome | root"home"

Responses:

StatusDescriptionContent TypeSchema
204Successful Response
422Validation Errorapplication/jsonHTTPValidationError

DELETE /api/v0/skills/{name}/authored

Delete Authored Skill

Parameters:

NameInRequiredTypeDefaultDescription
namepathyesstring
scopequerynohome | root"home"

Responses:

StatusDescriptionContent TypeSchema
204Successful Response
422Validation Errorapplication/jsonHTTPValidationError

DELETE /api/v0/skills/{name}/configured

Remove Configured Skill

Parameters:

NameInRequiredTypeDefaultDescription
namepathyesstring
scopequerynohome | root"home"

Responses:

StatusDescriptionContent TypeSchema
204Successful Response
422Validation Errorapplication/jsonHTTPValidationError

Chores

Chore definition and execution endpoints.

GET /api/v0/chores

List Chores

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonarray<ChoreInfo>

GET /api/v0/chores/{chore_id}

Get Chore

Parameters:

NameInRequiredTypeDefaultDescription
chore_idpathyesstring

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonChoreDetail
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v0/chores

Create Chore

Request body:

Content TypeRequiredSchema
application/jsonyesChoreCreateRequest

Responses:

StatusDescriptionContent TypeSchema
201Successful Responseapplication/jsonChoreDetail
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v0/chores/{chore_id}/cancel

Cancel Chore

Parameters:

NameInRequiredTypeDefaultDescription
chore_idpathyesstring

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonany
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v0/chores/{chore_id}/run

Run Chore

Parameters:

NameInRequiredTypeDefaultDescription
chore_idpathyesstring

Responses:

StatusDescriptionContent TypeSchema
202Successful Responseapplication/jsonany
422Validation Errorapplication/jsonHTTPValidationError

DELETE /api/v0/chores/{chore_id}

Delete Chore Definition

Parameters:

NameInRequiredTypeDefaultDescription
chore_idpathyesstring

Responses:

StatusDescriptionContent TypeSchema
204Successful Response
422Validation Errorapplication/jsonHTTPValidationError

PATCH /api/v0/chores/{chore_id}

Update Chore

Parameters:

NameInRequiredTypeDefaultDescription
chore_idpathyesstring

Request body:

Content TypeRequiredSchema
application/jsonyesChorePatchRequest

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonChoreDetail
422Validation Errorapplication/jsonHTTPValidationError

Runs

Run execution and inspection endpoints.

GET /api/v0/runs

List Runs

Parameters:

NameInRequiredTypeDefaultDescription
limitquerynointeger50
thread_idquerynostring | null
statusquerynopending | running | succeeded | failed | canceled | null

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonarray<RunInfo>
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v0/runs/defaults

Get Run Defaults

Return concrete defaults and workdir for a client-owned run session.

Parameters:

NameInRequiredTypeDefaultDescription
thread_idquerynostring | null

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonobject
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v0/runs/live

Get Live Execution Trees

Parameters:

NameInRequiredTypeDefaultDescription
root_run_idquerynostring | null

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonLiveSnapshot
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v0/runs/{run_id}

Get Run

Parameters:

NameInRequiredTypeDefaultDescription
run_idpathyesstring

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonRunDetail
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v0/runs/{run_id}/stream

Stream Run Events

Parameters:

NameInRequiredTypeDefaultDescription
run_idpathyesstring
afterquerynostring | null

Responses:

StatusDescriptionContent TypeSchema
200Successful Responsetext/event-streamany
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v0/chat/runs/authored/stream

Execute Authored Run Stream

Parameters:

NameInRequiredTypeDefaultDescription
afterquerynostring | null

Request body:

Content TypeRequiredSchema
application/jsonyesAuthoredRunRequest

Responses:

StatusDescriptionContent TypeSchema
200Successful Responsetext/event-streamany
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v0/chat/runs/stream

Execute Run Stream

Parameters:

NameInRequiredTypeDefaultDescription
afterquerynostring | null

Request body:

Content TypeRequiredSchema
application/jsonyesRunCreateRequest

Responses:

StatusDescriptionContent TypeSchema
200Successful Responsetext/event-streamany
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v0/chat/runs/{run_id}/rerun

Rerun Run

Parameters:

NameInRequiredTypeDefaultDescription
run_idpathyesstring

Request body:

Content TypeRequiredSchema
application/jsonnoRunRerunRequest | null

Responses:

StatusDescriptionContent TypeSchema
202Successful Responseapplication/jsonRunCommandResult
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v0/chat/runs/{run_id}/rerun/stream

Rerun Authored Run Stream

Parameters:

NameInRequiredTypeDefaultDescription
run_idpathyesstring
afterquerynostring | null

Request body:

Content TypeRequiredSchema
application/jsonyesAuthoredRerunRequest

Responses:

StatusDescriptionContent TypeSchema
200Successful Responsetext/event-streamany
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v0/chat/runs/{run_id}/steer

Steer Run

Parameters:

NameInRequiredTypeDefaultDescription
run_idpathyesstring

Request body:

Content TypeRequiredSchema
application/jsonyesRunSteerRequest

Responses:

StatusDescriptionContent TypeSchema
202Successful Responseapplication/jsonRunCommandResult
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v0/runs/authored/stream

Execute Authored Run Stream

Parameters:

NameInRequiredTypeDefaultDescription
afterquerynostring | null

Request body:

Content TypeRequiredSchema
application/jsonyesAuthoredRunRequest

Responses:

StatusDescriptionContent TypeSchema
200Successful Responsetext/event-streamany
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v0/runs/input-references

Discover Client File Inputs

Request body:

Content TypeRequiredSchema
application/jsonyesInputReferencesRequest

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonInputReferencesResponse
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v0/runs/stream

Execute Run Stream

Parameters:

NameInRequiredTypeDefaultDescription
afterquerynostring | null

Request body:

Content TypeRequiredSchema
application/jsonyesRunCreateRequest

Responses:

StatusDescriptionContent TypeSchema
200Successful Responsetext/event-streamany
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v0/runs/threads

Create Execution Thread

Request body:

Content TypeRequiredSchema
application/jsonyesThreadCreateRequest

Responses:

StatusDescriptionContent TypeSchema
201Successful Responseapplication/jsonThreadResult
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v0/runs/workdir/resolve

Resolve Run Workdir

Resolve a proposed location without accepting or mutating a Run.

Request body:

Content TypeRequiredSchema
application/jsonyesWorkdirResolveRequest

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonobject<string, string>
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v0/runs/{run_id}/cancel

Cancel Run

Parameters:

NameInRequiredTypeDefaultDescription
run_idpathyesstring

Request body:

Content TypeRequiredSchema
application/jsonnoRunCancelRequest | null

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonRunCommandResult
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v0/runs/{run_id}/rerun

Rerun Run

Parameters:

NameInRequiredTypeDefaultDescription
run_idpathyesstring

Request body:

Content TypeRequiredSchema
application/jsonnoRunRerunRequest | null

Responses:

StatusDescriptionContent TypeSchema
202Successful Responseapplication/jsonRunCommandResult
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v0/runs/{run_id}/rerun/stream

Rerun Authored Run Stream

Parameters:

NameInRequiredTypeDefaultDescription
run_idpathyesstring
afterquerynostring | null

Request body:

Content TypeRequiredSchema
application/jsonyesAuthoredRerunRequest

Responses:

StatusDescriptionContent TypeSchema
200Successful Responsetext/event-streamany
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v0/runs/{run_id}/steer

Steer Run

Parameters:

NameInRequiredTypeDefaultDescription
run_idpathyesstring

Request body:

Content TypeRequiredSchema
application/jsonyesRunSteerRequest

Responses:

StatusDescriptionContent TypeSchema
202Successful Responseapplication/jsonRunCommandResult
422Validation Errorapplication/jsonHTTPValidationError

Threads

Thread lifecycle and inspection endpoints.

GET /api/v0/threads

List Threads

Parameters:

NameInRequiredTypeDefaultDescription
limitquerynointeger50
kindquerynoThreadKind | null
statusquerynostring | null

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonarray<ThreadInfo>
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v0/threads/{thread_id}

Get Thread

Parameters:

NameInRequiredTypeDefaultDescription
thread_idpathyesstring
limitquerynointeger50

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonThreadDetail
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v0/threads/{thread_id}/result

Get Latest Thread Result

Parameters:

NameInRequiredTypeDefaultDescription
thread_idpathyesstring

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonRunDetail
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v0/threads/{thread_id}/stream

Stream Thread Events

Parameters:

NameInRequiredTypeDefaultDescription
thread_idpathyesstring
afterquerynostring | null

Responses:

StatusDescriptionContent TypeSchema
200Successful Responsetext/event-streamany
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v0/threads

Create Thread

Request body:

Content TypeRequiredSchema
application/jsonyesThreadCreateRequest

Responses:

StatusDescriptionContent TypeSchema
201Successful Responseapplication/jsonThreadResult
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v0/threads/{thread_id}/fork

Fork Thread

Parameters:

NameInRequiredTypeDefaultDescription
thread_idpathyesstring

Request body:

Content TypeRequiredSchema
application/jsonyesThreadForkRequest

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonThreadResult
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v0/threads/{thread_id}/rewind

Rewind Thread

Parameters:

NameInRequiredTypeDefaultDescription
thread_idpathyesstring

Request body:

Content TypeRequiredSchema
application/jsonyesThreadRewindRequest

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonThreadResult
422Validation Errorapplication/jsonHTTPValidationError

Stats

Execution usage by time, scope, and model.

GET /api/v0/stats/daily

Daily

Parameters:

NameInRequiredTypeDefaultDescription
start_datequeryyesstring (date)
end_datequeryyesstring (date)
timezonequeryyesstring
model_refquerynostring | nullstring: length >= 1
thread_idquerynostring | null
root_run_idquerynostring | null

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonStatsResponse_list_DailyRow__
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v0/stats/models

Models

Parameters:

NameInRequiredTypeDefaultDescription
windowquerynoall | 1y | 1mo | 1w | 1d | 4h | 1h | 30m"1mo"
thread_idquerynostring | null
root_run_idquerynostring | null

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonModelsResponse
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v0/stats/recent

Recent

Parameters:

NameInRequiredTypeDefaultDescription
periodquerynointeger3600value >= 1; value <= 28800

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonRecentUsage
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v0/stats/summary

Summary

Parameters:

NameInRequiredTypeDefaultDescription
model_refquerynostring | nullstring: length >= 1
thread_idquerynostring | null
root_run_idquerynostring | null

Responses:

StatusDescriptionContent TypeSchema
200Successful Responseapplication/jsonStatsResponse_list_WindowRow__
422Validation Errorapplication/jsonHTTPValidationError

Schemas

Schema: ActivitySnapshot

FieldRequiredTypeDefaultDescription
completedyesCompletedRoots
idlenobooleanfalse
liveyesLiveSnapshot | null
live_errornostring | null
page_errornostring | null
retirednoarray<RunNode>[]

Schema: AgentCapResource

Stable identity of one State capability available to an agent.

FieldRequiredTypeDefaultDescription
kindyesstring
nameyesstring
refyesstring

Schema: AgentCeiling

Stable queries that can only narrow agent resources.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
modelsnoarray<string> | null
promptsnoarray<string> | null
psychesnoarray<string> | null
servicesnoarray<string> | null
skillsnoarray<string> | null
toolsnoarray<string> | null

Schema: AgentResources

Stable ordered resources available at one execution point.

FieldRequiredTypeDefaultDescription
capsnoarray<AgentCapResource>[]
modelsnoarray<string>[]
toolsnoarray<AgentToolResource>[]

Schema: AgentToolResource

Stable identity of one model-facing tool available to an agent.

FieldRequiredTypeDefaultDescription
model_nameyesstring
nameyesstring
pluginyesstring
toolsetyesstring

Schema: Array_Value_

One immutable typed Toolang array.

FieldRequiredTypeDefaultDescription
typeyesstring
valueyesarray<Value>

Schema: AskStmt

FieldRequiredTypeDefaultDescription
bindingnostring | null"_"
docnostring | null
namenostring | null
requestyesstring
spanyesSpan

Schema: AudioInputPart

One audio input part.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
datanostring | null
data_urlnostring | null
filenamenostring | null
formatnomp3 | wav | null
media_typenostring | null
typeyesaudio

Schema: AudioPart-Input

One canonical audio input part.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
datayesstring
filenamenostring | null
formatyesmp3 | wav
media_typenostring | null
transcriptnostring | null
typenoaudio"audio"

Schema: AudioPart-Output

One canonical audio input part.

FieldRequiredTypeDefaultDescription
datayesstring
filenamenostring | null
formatyesmp3 | wav
media_typenostring | null
transcriptnostring | null
typenoaudio"audio"

Schema: AuthoredRerunRequest

One unresolved rerun request for server-owned resolution.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
client_idnostring | nullstring: length >= 1
commandsnoarray<RunOverridePayload>
modelnoModelRequest | null
model_overridenoModelOverride | null
request_idyesstring

Schema: AuthoredRunRequest

One materialized authored run request.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
attachmentsnoobject<string, TextPart-Input | ReasoningPart-Input | ImagePart-Input | AudioPart-Input | DocumentPart-Input | ToolCallPart-Input | ToolResultPart-Input> | null
client_idnostring | nullstring: length >= 1
drivernochat | chore | talk | null
modelyesModelRequest | null
policyyesRunPolicy
request_idyesstring
runnableyesRunnableRequest_str_
source_revisionnostring | null
thread_idyesstring
workdirnostring | null
workdir_basenostring | null

Schema: AwaitStmt

FieldRequiredTypeDefaultDescription
bindingnostring | null"_"
docnostring | null
handleyesstring
spanyesSpan

Schema: CallCounters

Actual model/tool invocation entries within one Run subtree.

FieldRequiredTypeDefaultDescription
model_callsnointeger0
tool_callsnointeger0

Schema: CancelControlPayload

Optional run cancellation reason values.

FieldRequiredTypeDefaultDescription
inputnoobject<string, Value | string>

Schema: CapDetail

Complete representation of one effective capability.

FieldRequiredTypeDefaultDescription
capyesstring
contentnostring | null
definition_fileyesstring
descriptionyesstring | null
editableyesboolean
filesnoarray<string> | null
formyesauthored | inline | configured | referenced
kindyespsyche | skill | service | prompt
linenointeger | null
nameyesstring
originyeslocal | remote
scopeyesroot | home | here
sourceyesstring
summarynostring | null

Schema: CapInfo

Summary of one effective capability.

FieldRequiredTypeDefaultDescription
capyesstring
definition_fileyesstring
descriptionyesstring | null
editableyesboolean
formyesauthored | inline | configured | referenced
kindyespsyche | skill | service | prompt
linenointeger | null
nameyesstring
originyeslocal | remote
scopeyesroot | home | here
sourceyesstring
summarynostring | null

Schema: ChdirControlPayload

One durable Run-local working location transition.

FieldRequiredTypeDefaultDescription
causenochdir"chdir"
cwdyesstring
statenostring | null

Schema: ChoreCreateRequest

Request one authored chore creation.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
bodynostring""
nameyesstring
schedulenostring | null
titlenostring | null

Schema: ChoreDetail

FieldRequiredTypeDefaultDescription
bodyyesstring
idyesstring | null
lineyesinteger | null
nameyesstring
pathyesstring
refyesstring
runtimeyesChoreRuntimeInfo
scheduleyesstring | null
source_erroryesstring | null
titleyesstring

Schema: ChoreInfo

FieldRequiredTypeDefaultDescription
idyesstring | null
lineyesinteger | null
nameyesstring
pathyesstring
refyesstring
runtimeyesChoreRuntimeInfo
scheduleyesstring | null
source_erroryesstring | null
titleyesstring

Schema: ChorePatchRequest

Request one authored chore update.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
bodynostring | null
schedulenostring | null
titlenostring | null

Schema: ChoreRuntimeInfo

Checkpoint state; synced indicates whether it describes the current definition.

FieldRequiredTypeDefaultDescription
active_run_idyesstring | null
last_runyesLastRunInfo | null
next_scheduled_atyesstring | null
pending_atyesstring | null
scheduler_erroryesstring | null
statusyespending | running | done | failed | canceled | null
syncedyesboolean
thread_idyesstring | null
updated_atyesstring | null

Schema: CollectionStepReport

Collection cardinality learned while executing one Flow Step.

FieldRequiredTypeDefaultDescription
output_itemsnointeger | null
total_itemsyesinteger

Schema: CompactControlPayload

One published compaction made available for adoption.

FieldRequiredTypeDefaultDescription
horizonyesstring

Schema: CompletedRoots

One bounded page, with counts over the entire completion interval.

FieldRequiredTypeDefaultDescription
countsyesCompletionCounts
endyesstring
observed_atyesstring
rootsyesarray<RunNode>
startyesstring

Schema: CompletionCounts

FieldRequiredTypeDefaultDescription
cancelednointeger0
failednointeger0
succeedednointeger0
totalyesinteger

Schema: ConfiguredCapRequest

One configured cap ref mutation request.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
refyesstring
scopenohome | root"home"

Schema: ControlInfo

One accepted execution control.

FieldRequiredTypeDefaultDescription
client_idnostring | null
created_atyesstring
erroryesstring | null
finished_atyesstring | null
indexyesinteger
kindyesrun | chdir | recall | compact | exec | steer | cancel | create | fork | rewind
payloadyesRunControlPayload | ChdirControlPayload | CompactControlPayload | ExecControlPayload | SteerControlPayload | CancelControlPayload | RecallControlPayload | CreateControlPayload | ForkControlPayload | RewindControlPayload
request_idyesstring | null
run_idyesstring
statusyespending | applied | wontapply | revoked
timingyesimmediate | next_step | next_call
triggered_bynostring | null

Schema: ConversationScope

A source conversation bound to one invocation, never to a prefix.

FieldRequiredTypeDefaultDescription
backendyesstring
conversationyesstring

Schema: ConvoRulesRecallTarget

FieldRequiredTypeDefaultDescription
backendyesstring
conversationyesstring
kindnoconvo-rules"convo-rules"

Schema: DailyRow

FieldRequiredTypeDefaultDescription
cachedyesinteger | null
dateyesstring (date)
endyesstring
inyesinteger | null
model_callsyesinteger
outyesinteger | null
partialyesboolean
root_runsyesinteger | null
spendyesnumber | null
spend_approximateyesboolean
startyesstring
tool_callsyesinteger

Schema: DocumentInputPart

One document input part.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
datanostring | null
file_idnostring | null
filenamenostring | null
media_typenostring | null
typeyesdocument
urlnostring | null

Schema: DocumentPart-Input

One canonical document part.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
datanostring | null
file_idnostring | null
filenamenostring | null
media_typenostring | null
typenodocument"document"
urlnostring | null

Schema: DocumentPart-Output

One canonical document part.

FieldRequiredTypeDefaultDescription
datanostring | null
file_idnostring | null
filenamenostring | null
media_typenostring | null
typenodocument"document"
urlnostring | null

Schema: DropStmt

FieldRequiredTypeDefaultDescription
bindingnostring | null"_"
countnointeger | null
docnostring | null
lanesnointeger | null
positionnofirst | last | null
runnablenostring | null
spanyesSpan

Schema: ExecControlPayload

One durable same-Run runnable replacement.

FieldRequiredTypeDefaultDescription
inputyesobject<string, Value | string>
runnableyesstring
runnable_kindnostring""
stateyesstring

Schema: ExecStepReport

Committed native handoff, independent of successor Step delivery.

FieldRequiredTypeDefaultDescription
controlyesstring

Schema: ExecStmt

FieldRequiredTypeDefaultDescription
bindingnonull
docnostring | null
runnableyesstring
spanyesSpan

Schema: ForkControlPayload

Fork one thread at a visible run.

FieldRequiredTypeDefaultDescription
fork_atyesstring
fork_fromyesstring
fork_headyesstring

Schema: GenerateStmt

FieldRequiredTypeDefaultDescription
bindingnostring | null"_"
countyesinteger
docnostring | null
lanesnointeger | null
runnableyesstring
spanyesSpan

Schema: ImageInputPart

One image input part.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
detailnolow | high | auto | original"auto"
file_idnostring | null
filenamenostring | null
image_urlnostring | null
media_typenostring | null
typeyesimage

Schema: ImagePart-Input

One canonical image input part.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
detailnolow | high | auto | original"auto"
file_idnostring | null
filenamenostring | null
image_urlnostring | null
media_typenostring | null
typenoimage"image"

Schema: ImagePart-Output

One canonical image input part.

FieldRequiredTypeDefaultDescription
detailnolow | high | auto | original"auto"
file_idnostring | null
filenamenostring | null
image_urlnostring | null
media_typenostring | null
typenoimage"image"

Schema: InputMessagePayload

One user-authored input message.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
partsyesarray<TextInputPart | ImageInputPart | AudioInputPart | DocumentInputPart>
rolenouser"user"

Schema: InputReferencesRequest

Discover includes in source Content without reading server files.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
drivernochat | chore | talk | null
inputyesobject<string, string>
runnablenostring | null

Schema: InputReferencesResponse

FieldRequiredTypeDefaultDescription
referencesyesarray<string>
stateyesstring

Schema: IterationOccurrence

One loop iteration and the phase executing within it.

FieldRequiredTypeDefaultDescription
countnointeger | null
indexyesinteger
phaseyesbody | until

Schema: KeepStmt

FieldRequiredTypeDefaultDescription
bindingnostring | null"_"
countnointeger | null
docnostring | null
lanesnointeger | null
positionnofirst | last | null
runnablenostring | null
spanyesSpan

Schema: LastRunInfo

FieldRequiredTypeDefaultDescription
errornostring | null
finished_atyesstring | null
idyesstring
started_atyesstring | null
statusyesstring

Schema: LaunchContext

Captured context and result contract for admitted background work.

FieldRequiredTypeDefaultDescription
iterationsyesobject
resultyesOutputContract | null
settingsyesRunnableSettings
workspacesyesobject<string, string>

Schema: LetStmt

FieldRequiredTypeDefaultDescription
bindingnostring | null"_"
docnostring | null
spanyesSpan
valueyesstring

Schema: LiveSnapshot

FieldRequiredTypeDefaultDescription
epochyesstring
observed_atyesstring
treesyesarray<LiveTreeSnapshot>

Schema: LiveTreeSnapshot

FieldRequiredTypeDefaultDescription
nodesyesarray<RunNode | StepNode>
root_run_idyesstring
thread_idyesstring

Schema: LoopStepReport

Iteration count and terminal cause learned when a loop Step ends.

FieldRequiredTypeDefaultDescription
iterationsyesinteger
terminationyesexhausted | satisfied | exec | failed | canceled
totalnointeger | null

Schema: MapStmt

FieldRequiredTypeDefaultDescription
bindingnostring | null"_"
docnostring | null
lanesnointeger | null
runnableyesstring
spanyesSpan

Schema: Message

Stable canonical message payload.

FieldRequiredTypeDefaultDescription
partsnoarray<TextPart-Output | ReasoningPart-Output | ImagePart-Output | AudioPart-Output | DocumentPart-Output | ToolCallPart-Output | ToolResultPart-Output>
roleyesuser | assistant | tool

Schema: MessageRecall

The resource revision actually presented by a tagged message.

FieldRequiredTypeDefaultDescription
refyesstring
revisionyesstring

Schema: Metrics

FieldRequiredTypeDefaultDescription
cached_tokensnointeger | null0
input_tokensnointeger | null0
model_callsnointeger0
output_tokensnointeger | null0
root_runsnointeger0
spend_approximatenobooleanfalse
spend_microsnointeger | null0
tool_callsnointeger0

Schema: ModelCall

One normalized model call.

FieldRequiredTypeDefaultDescription
contnoobject | null
instructionsyesstring
max_output_tokensnointeger | null
messagesyesarray<Message>
output_schemanoobject | null
reasoningnoReasoning | null
toolsnoarray<ToolDefinition>

Schema: ModelCost

Selected model charge and the pricing/calculation evidence behind it.

FieldRequiredTypeDefaultDescription
amountnonumber | null
completenobooleanfalse
currencynostring | null
linesnoarray<ModelCostLine>[]
metersnoarray<ModelUsageMeter>[]
pricingnoModelPricing | null
sourcenoreported | estimated | zero | unknown"unknown"

Schema: ModelCostLine

One applied quantity and rate contributing to a model cost.

FieldRequiredTypeDefaultDescription
amountyesnumber
conditionnoobject | null
meteryesstring
peryesnumber
quantityyesnumber
rateyesnumber
unityesstring

Schema: ModelOverride

Sparse model identity and typed parameter changes from one input source.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
effortnostring | integer | auto | null
identitynostring | null
max_outputnointeger | auto | null

Schema: ModelPricing

Applied pricing plan and conditions captured for one completed call.

FieldRequiredTypeDefaultDescription
matchnoobject
plannostring"standard"

Schema: ModelRequest

One exact model ref and the controls this run asks for.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
max_outputnointeger | null
reasoningnoReasoning | null
refyesstring

Schema: ModelRow

FieldRequiredTypeDefaultDescription
cachedyesinteger | null
inyesinteger | null
model_callsyesinteger
model_refyesstring
outyesinteger | null
root_runsyesinteger | null
spendyesnumber | null
spend_approximateyesboolean
tool_callsyesinteger

Schema: ModelsResponse

FieldRequiredTypeDefaultDescription
datayesarray<ModelRow> | null
endyesstring | null
scopeyesScope
snapshotyesSnapshot
startyesstring | null
windowyesall | 1y | 1mo | 1w | 1d | 4h | 1h | 30m

Schema: ModelStepReport

Token usage, model cost and continuation learned by one model Step.

FieldRequiredTypeDefaultDescription
contnoobject | null
costnoModelCost | null
invokednobooleanfalse
usagenoTokenUsage | null

Schema: ModelStepSpec

Resolved model identity and normalized call known at Step begin.

FieldRequiredTypeDefaultDescription
callyesModelCall
modelyesstring
setupyesstring
statenostring | null

Schema: ModelUsageMeter

One auditable quantity within model-call accounting.

FieldRequiredTypeDefaultDescription
nameyesstring
quantityyesnumber
unitnostring"token"

Schema: Occurrence

Runtime position of one Run or Step within structural execution.

FieldRequiredTypeDefaultDescription
itemnoOccurrencePosition | null
iterationnoIterationOccurrence | null
lanenoOccurrencePosition | null

Schema: OccurrencePosition

One zero-based position within a known total.

FieldRequiredTypeDefaultDescription
countyesinteger
indexyesinteger

Schema: OutputContract

One output type and its referenced struct definitions at a call boundary.

FieldRequiredTypeDefaultDescription
definitionsyesobject<string, array<tuple<string, string, boolean>>>
type_nameyesstring

Schema: PromptInvocation

One resolved authored prompt invocation and its immutable definition.

FieldRequiredTypeDefaultDescription
argumentsyesarray<tuple<string, string>>
cap_refyesstring
content_hashyesstring
nameyesstring
parentyesinteger | null

Schema: PromptSetting

FieldRequiredTypeDefaultDescription
moduleyesstring
namenostring"default"

Schema: PsycheRecallTarget

FieldRequiredTypeDefaultDescription
kindnopsyche"psyche"
refyesstring

Schema: PutCapRequest

One authored cap write request.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
contentnostring | null
scopenohome | root"home"

Schema: Reasoning

One reasoning control requested for a model selection or call.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
budget_tokensnointeger | null
effortnostring | null

Schema: ReasoningPart-Input

Provider-returned reasoning text and its opaque native state.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
providernostring | null
provider_metadatanoobject
signaturenostring | null
textyesstring
typenoreasoning"reasoning"

Schema: ReasoningPart-Output

Provider-returned reasoning text and its opaque native state.

FieldRequiredTypeDefaultDescription
providernostring | null
provider_metadatanoobject
signaturenostring | null
textyesstring
typenoreasoning"reasoning"

Schema: RecallControlPayload

One immutable resource revision recalled by the runtime.

FieldRequiredTypeDefaultDescription
contentyesstring
revisionyesstring
targetyesConvoRulesRecallTarget | RulesRecallTarget | SkillRecallTarget | ServiceRecallTarget | PsycheRecallTarget | SkillTriggerRecallTarget | ServiceTriggerRecallTarget | WorkspaceRecallTarget

Schema: RecentUsage

Exact source-only usage in a bounded half-open interval.

FieldRequiredTypeDefaultDescription
endyesstring
metricsyesMetrics
observed_atyesstring
startyesstring

Schema: ReduceStmt

FieldRequiredTypeDefaultDescription
bindingnostring | null"_"
docnostring | null
initialnostring | null
runnableyesstring
spanyesSpan

Schema: RepeatStmt

FieldRequiredTypeDefaultDescription
bindingnonull
countnointeger | null
docnostring | null
runnablenostring | null
spanyesSpan
stmtsnoarray<RunStmt | AwaitStmt | SpawnStmt | ExecStmt | SeekStmt | AskStmt | GenerateStmt | ReduceStmt | MapStmt | KeepStmt | DropStmt | SortStmt | RepeatStmt | LetStmt>[]
until_indexnointeger | null
windownointeger3

Schema: RewindControlPayload

Rewind one thread with an optimistic head check.

FieldRequiredTypeDefaultDescription
rewind_fromyesstring
rewind_ifyesstring
rewind_throughyesstring

Schema: RulesRecallTarget

FieldRequiredTypeDefaultDescription
kindnorules"rules"
pathyesstring
workspaceyesstring

Schema: RunCancelRequest

Request run cancellation.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
client_idnostring | nullstring: length >= 1
expected_controlnostring | null
modenoimmediate | next_step | next_call"immediate"
reasonnostring | null
request_idnostring | null

Schema: RunCommand

One low-level command retained by execution and restart protocols.

FieldRequiredTypeDefaultDescription
fieldyesstring
groupyesallow | default | limit
valueyesarray<string> | string | integer | number | null

Schema: RunCommandResult

One accepted HTTP run control.

FieldRequiredTypeDefaultDescription
commandyesControlInfo
runyesRunDetail

Schema: RunControlPayload

Resolved preparation snapshot for one new run.

FieldRequiredTypeDefaultDescription
authored_commandsnoarray<RunCommand>[]
authored_inputnoobject<string, string> | null
authored_session_commandsnoarray<RunCommand>[]
conversationnoConversationScope | null
cwdnostring""
horizonnostring | null
inputyesobject<string, Value | string>
launch_contextnoLaunchContext | null
limitsyesRunLimits-Output
model_requestnoModelRequest | null
prompt_invocationsnoarray<PromptInvocation>[]
resourcesyesAgentResources
runnableyesstring
runnable_kindnostring""
runtime_sourcesnoobject<string, string>
sandboxnostring | null
spawn_threadnostring | null
stateyesstring | null

Schema: RunControlRefData

One caller-facing run-control reference.

FieldRequiredTypeDefaultDescription
indexyesinteger
runyesstring

Schema: RunCreateRequest

One non-interactive agic or flow execution request.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
client_idnostring | nullstring: length >= 1
modelyesModelRequest | null
policyyesRunPolicy
request_idyesstringlength >= 1
runnableyesRunnableRequest_object_
thread_idyesstringlength >= 1

Schema: RunDetail

One complete run detail schema.

FieldRequiredTypeDefaultDescription
call_kindyesstring
controlyesRunControlRefData
controlsyesarray<ControlInfo>
created_atyesstring
erroryesobject | null
finished_atyesstring | null
idyesstring
input_textyesstring
occurrenceyesOccurrence | null
outputyesobject | null
parentyesstring | null
root_run_idyesstring
runnable_kindyesstring
runnable_nameyesstring | null
started_atyesstring
stateyesRunControlRefData
statusyespending | running | succeeded | failed | canceled
stepsnoarray<StepData>
summaryyesstring
thread_idyesstring
updated_atyesstring

Schema: RunInfo

One caller-facing run summary and identity schema.

FieldRequiredTypeDefaultDescription
call_kindyesstring
created_atyesstring
erroryesobject | null
finished_atyesstring | null
idyesstring
input_textyesstring
occurrenceyesOccurrence | null
parentyesstring | null
root_run_idyesstring
runnable_kindyesstring
runnable_nameyesstring | null
started_atyesstring
stateyesRunControlRefData
statusyespending | running | succeeded | failed | canceled
summaryyesstring
thread_idyesstring
updated_atyesstring

Schema: RunLimits-Input

Limits applied to one root run tree.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
agic_model_callsnointeger | null200
agic_tool_callsnointeger | null
costnonumber | null
timenointeger | null
tokensnointeger | null

Schema: RunLimits-Output

Limits applied to one root run tree.

FieldRequiredTypeDefaultDescription
agic_model_callsnointeger | null200
agic_tool_callsnointeger | null
costnostring | null
timenointeger | null
tokensnointeger | null

Schema: RunLimitsPayload

One partial run-limit override.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
agic_model_callsnointeger | nullinteger: value >= 0.0
agic_tool_callsnointeger | nullinteger: value >= 0.0
costnonumber | null
timenointeger | nullinteger: value >= 0.0
tokensnointeger | nullinteger: value >= 0.0

Schema: RunnableRequest_object_

One optional entry selection and its complete input.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
inputnoobject
refyesstring | null

Schema: RunnableRequest_str_

One optional entry selection and its complete input.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
inputnoobject<string, string>
refyesstring | null

Schema: RunnableSettings

FieldRequiredTypeDefaultDescription
contextnoPromptSetting | null
handoffsnoarray<string>[]
handsnoarray<string>[]
instructnoPromptSetting | null
lanesnointeger4
modulenostring"agent"
recallnoarray<string>["far", "near"]

Schema: RunNode

Small resident Run state and cumulative subtree consumption.

FieldRequiredTypeDefaultDescription
callsnoCallCounters
costnonumber | null
cost_approximatenobooleanfalse
created_atyesstring
finished_atnostring | null
idyesstring
occurrencenoOccurrence | null
parentyesstring | null
runnableyesstring
runnable_kindnostring""
started_atnostring | null
statusyespending | running | succeeded | failed | canceled
thread_idnostring | null
typenorun"run"
usagenoTokenUsage | null

Schema: RunOverridePayload

One retained low-level restart command on the stable HTTP wire.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
fieldyesstring
groupyesallow | default | limit
valueyesarray<string> | string | integer | null

Schema: RunPolicy

Materialized caller policy for one root run.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
allownoarray<AgentCeiling>[]
limitsnoRunLimits-Input

Schema: RunRerunRequest

Request a new run from one source invocation.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
client_idnostring | nullstring: length >= 1
limitsnoRunLimitsPayload | null
modelnoModelRequest | null
request_idnostring | nullstring: length >= 1

Schema: RunSteerRequest

Request one steering message for a running run.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
client_idnostring | nullstring: length >= 1
expected_controlnostring | null
messageyesInputMessagePayload
modenoimmediate | next_step | next_call"next_step"
request_idnostring | null

Schema: RunStmt

FieldRequiredTypeDefaultDescription
asynchronousnobooleanfalse
bindingnostring | null"_"
docnostring | null
runnableyesstring
spanyesSpan

Schema: RuntimeLaunchRequest

Target one server generation for retention or promotion.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
launch_idyesstringlength >= 1

Schema: RuntimeLifecyclePayload

Live server retention policy, independent of driver selection.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
api_versionnointeger0value >= 0.0; value <= 0.0
launch_idyesstring
lifetimeyespersistent | foreground | automatic

Schema: Scope

FieldRequiredTypeDefaultDescription
idnostring""
kindnoagent | thread | root_run"agent"

Schema: SeekStmt

FieldRequiredTypeDefaultDescription
bindingnostring | null"_"
docnostring | null
nameyesstring
runnableyesstring
spanyesSpan

Schema: ServiceRecallTarget

FieldRequiredTypeDefaultDescription
kindnoservice"service"
refyesstring

Schema: ServiceTriggerRecallTarget

FieldRequiredTypeDefaultDescription
kindnoservice-trigger"service-trigger"
refyesstring

Schema: SkillRecallTarget

FieldRequiredTypeDefaultDescription
kindnoskill"skill"
refyesstring

Schema: SkillTriggerRecallTarget

FieldRequiredTypeDefaultDescription
kindnoskill-trigger"skill-trigger"
refyesstring

Schema: Snapshot

FieldRequiredTypeDefaultDescription
computed_atyesstring | null
initializingyesboolean
queried_atyesstring
refresh_erroryesstring | null
refreshingyesboolean
staleyesboolean

Schema: SortStmt

FieldRequiredTypeDefaultDescription
bindingnostring | null"_"
docnostring | null
lanesnointeger | null
orderyesascending | descending
runnableyesstring
spanyesSpan

Schema: Span

FieldRequiredTypeDefaultDescription
lineyesinteger

Schema: SpawnStmt

FieldRequiredTypeDefaultDescription
bindingnostring | null
docnostring | null
runnableyesstring
spanyesSpan

Schema: StatsResponse_list_DailyRow__

StatsResponse[list[DailyRow]]

FieldRequiredTypeDefaultDescription
datayesarray<DailyRow> | null
scopeyesScope
snapshotyesSnapshot

Schema: StatsResponse_list_WindowRow__

StatsResponse[list[WindowRow]]

FieldRequiredTypeDefaultDescription
datayesarray<WindowRow> | null
scopeyesScope
snapshotyesSnapshot

Schema: SteerControlPayload

Values injected at one agic model boundary.

FieldRequiredTypeDefaultDescription
inputyesobject<string, Value | string>

Schema: StepData

One caller-facing execution step.

FieldRequiredTypeDefaultDescription
aborted_bynostring | null
created_atnostring""
errornoobject | null
finished_atnostring | null
inputyesarray<string>
kindyesexec | run | spawn | agent | human | model | tool | par | loop | value
occurrencenoOccurrence | null
outputyesobject | null
pathyesstring
preceded_bynoarray<string>[]
reportnoExecStepReport | ModelStepReport | ToolStepReport | CollectionStepReport | LoopStepReport | null
specyesany
started_atnostring""
stateyesRunControlRefData
statusnopending | running | succeeded | failed | canceled"running"

Schema: StepNode

Current Step identity and direct invocation facts, without call bodies.

FieldRequiredTypeDefaultDescription
asynchronousnobooleanfalse
costnonumber | null
cost_approximatenobooleanfalse
created_atyesstring
finished_atnostring | null
idyesstring
invokednobooleanfalse
kindyesexec | run | spawn | agent | human | model | tool | par | loop | value
namenostring""
occurrencenoOccurrence | null
operationyesstring
parentyesstring
pluginnostring""
started_atyesstring
statusyespending | running | succeeded | failed | canceled
summarynostring""
targetnostring""
typenostep"step"
usagenoTokenUsage | null

Schema: Struct_Value_

One immutable authored Toolang struct value.

FieldRequiredTypeDefaultDescription
typeyesstring
valueyesobject<string, Value>

Schema: TextInputPart

One text input part.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
textyesstring
typeyestext

Schema: TextPart-Input

One canonical text part.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
providernostring | null
provider_metadatanoobject
signaturenostring | null
textyesstring
typenotext"text"

Schema: TextPart-Output

One canonical text part.

FieldRequiredTypeDefaultDescription
providernostring | null
provider_metadatanoobject
signaturenostring | null
textyesstring
typenotext"text"

Schema: ThreadControlRefData

One caller-facing thread-control reference.

FieldRequiredTypeDefaultDescription
indexyesinteger
threadyesstring

Schema: ThreadCreateRequest

Request one empty thread.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
client_idnostring | nullstring: length >= 1
request_idnostring | nullstring: length >= 1

Schema: ThreadDetail

One complete thread detail schema.

FieldRequiredTypeDefaultDescription
active_runyesThreadRunInfo | null
created_atyesstring
created_byyesThreadControlRefData
headyesThreadControlRefData
idyesstring
latest_runyesThreadRunInfo | null
run_countyesinteger
runsnoarray<RunDetail>
statusyesstring
titleyesstring
updated_atyesstring

Schema: ThreadForkRequest

Request a thread fork from one anchor run.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
client_idnostring | nullstring: length >= 1
request_idnostring | null
run_idnostring | nullstring: length >= 1

Schema: ThreadInfo

One thread summary, with latest_run identifying its latest visible root.

FieldRequiredTypeDefaultDescription
active_runyesThreadRunInfo | null
created_atyesstring
created_byyesThreadControlRefData
headyesThreadControlRefData
idyesstring
latest_runyesThreadRunInfo | null
run_countyesinteger
statusyesstring
titleyesstring
updated_atyesstring

Schema: ThreadResult

One HTTP thread mutation response.

FieldRequiredTypeDefaultDescription
threadyesThreadInfo

Schema: ThreadRewindRequest

Request a thread rewind from one anchor run.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
client_idnostring | nullstring: length >= 1
request_idnostring | null
run_idnostring | nullstring: length >= 1

Schema: ThreadRunInfo

One compact run summary embedded in a thread summary.

FieldRequiredTypeDefaultDescription
created_atyesstring
finished_atyesstring | null
idyesstring
started_atyesstring
statusyespending | running | succeeded | failed | canceled
updated_atyesstring

Schema: TokenUsage

Inclusive token totals and optional client-relevant components.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
cache_read_tokensnointeger | null
input_tokensyesinteger
output_tokensyesinteger
reasoning_tokensnointeger | null

Schema: ToolCall

One tool invocation initiated by a model or the runtime.

FieldRequiredTypeDefaultDescription
call_idyesstring
inputyesobject
nameyesstring
tool_call_idyesstring

Schema: ToolCallPart-Input

One canonical tool-call part.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
call_idnostring | null
inputnoobject
providernostring | null
provider_metadatanoobject
signaturenostring | null
tool_call_idyesstring
tool_familyyesstring
tool_nameyesstring
typenotool_call"tool_call"

Schema: ToolCallPart-Output

One canonical tool-call part.

FieldRequiredTypeDefaultDescription
call_idnostring | null
inputnoobject
providernostring | null
provider_metadatanoobject
signaturenostring | null
tool_call_idyesstring
tool_familyyesstring
tool_nameyesstring
typenotool_call"tool_call"

Schema: ToolDefinition

One model-facing tool definition.

FieldRequiredTypeDefaultDescription
descriptionyesstring
nameyesstring
parametersnoobject

Schema: ToolResultPart-Input

One canonical tool-result part.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
call_idnostring | null
errornostring | null
outputnoobject
tool_call_idyesstring
tool_familyyesstring
tool_nameyesstring
typenotool_result"tool_result"

Schema: ToolResultPart-Output

One canonical tool-result part.

FieldRequiredTypeDefaultDescription
call_idnostring | null
errornostring | null
outputnoobject
tool_call_idyesstring
tool_familyyesstring
tool_nameyesstring
typenotool_result"tool_result"

Schema: ToolStepReport

Human-readable terminal summary learned when a tool Step ends.

FieldRequiredTypeDefaultDescription
invokednobooleanfalse
summaryyesstring

Schema: ToolStepSpec

Resolved plugin, invocation provenance, and call known at Step begin.

FieldRequiredTypeDefaultDescription
callyesToolCall
pluginyesstring
summarynostring""
triggernomodel | runtime"model"

Schema: WindowRow

FieldRequiredTypeDefaultDescription
cachedyesinteger | null
endyesstring | null
inyesinteger | null
model_callsyesinteger
outyesinteger | null
root_runsyesinteger | null
spendyesnumber | null
spend_approximateyesboolean
startyesstring | null
tool_callsyesinteger
windowyesall | 1y | 1mo | 1w | 1d | 4h | 1h | 30m

Schema: WorkdirResolveRequest

Resolve one session or run workdir without creating a Run.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
thread_idnostring | null
workdirnostring | null
workdir_basenostring | null

Schema: WorkspaceInfo

One State grant and its availability in the inspecting runtime.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
availableyesboolean
nameyesstring
pathyesstring

Schema: WorkspaceInspection

Workspace inspection bound to one published State revision.

Additional fields are rejected.

FieldRequiredTypeDefaultDescription
itemsyesarray<WorkspaceInfo>
revisionyesstring
workdiryesstring | null

Schema: WorkspaceRecallTarget

FieldRequiredTypeDefaultDescription
kindnoworkspace"workspace"
refyesstring

Schema: CreateControlPayload

Create one empty thread.

Type: object

Schema: ThreadKind

Context kinds encoded by canonical Thread ID prefixes.

Values: chat, chore, talk, work, exec

Schema: Value

Type: string | integer | number | boolean | TextPart-Output | ReasoningPart-Output | ImagePart-Output | AudioPart-Output | DocumentPart-Output | ToolCallPart-Output | ToolResultPart-Output | Array_Value_ | Struct_Value_ | array<Value> | object<string, Value> | null

Schema: HTTPValidationError

FieldRequiredTypeDefaultDescription
detailnoarray<ValidationError>

Schema: ValidationError

FieldRequiredTypeDefaultDescription
ctxnoobject
inputnoany
locyesarray<string | integer>
msgyesstring
typeyesstring