Agents and automation
Agent work
Where agents' work is organised: threads you talk to them in, jobs that move through stages with checks, plans and their items, steps and pipelines, messages between agents, shared terminals, and the runners that do the work on your own subscription. Use it to hand work to agents, follow it as it moves, and see what each one is doing.
70 methods
Threads and messages
- GETList threads/v1/coordinator/threads
- POSTOpen a thread/v1/coordinator/threads
- GETGet a thread/v1/coordinator/threads/{thread_id}
- POSTClose a thread/v1/coordinator/threads/{thread_id}/close
- GETList a thread's messages/v1/coordinator/threads/{thread_id}/messages
- POSTPost to a thread/v1/coordinator/threads/{thread_id}/messages
- GETList a thread's runs/v1/coordinator/threads/{thread_id}/turns
Jobs
- GETList coordinator jobs/v1/coordinator/jobs
- POSTFile a job/v1/coordinator/jobs
- GETGet a job/v1/coordinator/jobs/{job_id}
- GETList a job's moves/v1/coordinator/jobs/{job_id}/transitions
- POSTRevert a job/v1/coordinator/jobs/{job_id}/revert
- POSTSend a job back/v1/coordinator/jobs/{job_id}/go-back
- POSTRelease a held job/v1/coordinator/jobs/{job_id}/release
- POSTCancel a job/v1/coordinator/jobs/{job_id}/cancel
- POSTPause a job/v1/coordinator/jobs/{job_id}/pause
- POSTResume a paused job/v1/coordinator/jobs/{job_id}/resume
- POSTRetry a job now/v1/coordinator/jobs/{job_id}/retry
Plans and plan items
- GETList plans/v1/coordinator/plans
- GETGet a plan/v1/coordinator/plans/{plan_id}
- POSTCreate a plan/v1/coordinator/plans
- GETGet the plans overview/v1/coordinator/plan/overview
- SSEWatch the plans overview/v1/coordinator/plan/events
- PUTAdd or change a plan item/v1/coordinator/plans/{plan_id}/items/{item_id}
- POSTAdd a note to a plan item/v1/coordinator/plans/{plan_id}/items/{item_id}/notes
Steps and pipelines
- GETList steps/v1/coordinator/steps
- GETGet a step/v1/coordinator/steps/{step_id}
- POSTFile a step/v1/coordinator/steps
- POSTRun a step/v1/coordinator/steps/{step_id}/evaluate
- GETList a step's runs/v1/coordinator/steps/{step_id}/evaluations
- GETList pipeline templates/v1/coordinator/pipelines
- GETGet a pipeline template/v1/coordinator/pipelines/{pipeline_id}
- POSTFile a pipeline template/v1/coordinator/pipelines
Overview and watching
- GETList open items/v1/coordinator/open-items
- GETGet the state machine/v1/coordinator/machine
- GETGet the work picture/v1/coordinator/picture
- SSEWatch the work picture/v1/coordinator/picture/events
- GETList watch grants/v1/coordinator/watch-grants
- POSTGrant the full picture/v1/coordinator/watch-grants
- DELETERevoke a watch grant/v1/coordinator/watch-grants/{grant_id}
Agent messages and terminals
- POSTSend an agent message/v1/coordinator/messages
- GETList an agent inbox/v1/coordinator/inbox
- SSEWatch an agent inbox/v1/coordinator/inbox/events
- POSTAcknowledge agent messages/v1/coordinator/inbox/ack
- GETList terminals/v1/coordinator/terminals
- SSEWatch a terminal/v1/coordinator/terminals/{handle}/events
- POSTSend a terminal message/v1/coordinator/terminals/{handle}/messages
Runners and pools
Build slots
Drift and host actions
Runner protocol
Called by the InOrbit runner. You do not need these to use the API.
- POSTGet a registration challenge/v1/coordinator/runners/challenge
- POSTRegister a runner/v1/coordinator/runners
- POSTSend a runner heartbeat/v1/coordinator/runners/{runner_id}/heartbeat
- SSEServe voice calls/v1/coordinator/runners/{runner_id}/voice/events
- POSTReport a voice answer/v1/coordinator/voice/{lease_id}/deltas
- POSTAccept a lease/v1/coordinator/leases/{lease_id}/accept
- GETGet a turn's pack/v1/coordinator/leases/{lease_id}/pack
- POSTRenew a lease/v1/coordinator/leases/{lease_id}/heartbeat
- POSTReport a turn/v1/coordinator/turns/{turn_id}/report
- POSTSubmit a gate report/v1/coordinator/jobs/{job_id}/gate-report
- POSTSend a role heartbeat/v1/coordinator/personalities/{personality_id}/heartbeat