API Reference
Libraries
API Overview
Agents
Get Agent by ID
GET/agents/{agent_id}
Delete Agent by ID
DELETE/agents/{agent_id}
List Agents
GET/agents
Handle Agent RPC by ID
POST/agents/{agent_id}/rpc
Get Agent by Name
GET/agents/name/{agent_name}
Delete Agent by Name
DELETE/agents/name/{agent_name}
Handle Agent RPC by Name
POST/agents/name/{agent_name}/rpc
Register Build
POST/agents/register-build
AgentsDeployments
Create Deployment
POST/agents/{agent_id}/deployments
List Deployments
GET/agents/{agent_id}/deployments
Get Deployment
GET/agents/{agent_id}/deployments/{deployment_id}
Delete Deployment
DELETE/agents/{agent_id}/deployments/{deployment_id}
Promote Deployment
POST/agents/{agent_id}/deployments/{deployment_id}/promote
Preview RPC
POST/agents/{agent_id}/deployments/{deployment_id}/rpc
AgentsSchedules
Create Run Schedule
POST/agents/{agent_id}/schedules
List Run Schedules
GET/agents/{agent_id}/schedules
Get Run Schedule
GET/agents/{agent_id}/schedules/{schedule_id}
Update Run Schedule
PATCH/agents/{agent_id}/schedules/{schedule_id}
Delete Run Schedule
DELETE/agents/{agent_id}/schedules/{schedule_id}
Pause Run Schedule
POST/agents/{agent_id}/schedules/{schedule_id}/pause
Resume Run Schedule
POST/agents/{agent_id}/schedules/{schedule_id}/resume
Trigger Run Schedule
POST/agents/{agent_id}/schedules/{schedule_id}/trigger
Skip Run Schedule Action
POST/agents/{agent_id}/schedules/{schedule_id}/skip
Unskip Run Schedule Action
POST/agents/{agent_id}/schedules/{schedule_id}/unskip
Get Run Schedule By Name
GET/agents/{agent_id}/schedules/name/{name}
Update Run Schedule By Name
PATCH/agents/{agent_id}/schedules/name/{name}
Delete Run Schedule By Name
DELETE/agents/{agent_id}/schedules/name/{name}
Pause Run Schedule By Name
POST/agents/{agent_id}/schedules/name/{name}/pause
Resume Run Schedule By Name
POST/agents/{agent_id}/schedules/name/{name}/resume
Trigger Run Schedule By Name
POST/agents/{agent_id}/schedules/name/{name}/trigger
Tasks
Get Task by ID
GET/tasks/{task_id}
Delete Task by ID
DELETE/tasks/{task_id}
List Tasks
GET/tasks
Stream Task Events by ID
GET/tasks/{task_id}/stream
Get Task by Name
GET/tasks/name/{task_name}
Delete Task by Name
DELETE/tasks/name/{task_name}
Stream Task Events by Name
GET/tasks/name/{task_name}/stream
Update Task by ID
PUT/tasks/{task_id}
Update Task by Name
PUT/tasks/name/{task_name}
Complete Task
POST/tasks/{task_id}/complete
Fail Task
POST/tasks/{task_id}/fail
Cancel Task
POST/tasks/{task_id}/cancel
Terminate Task
POST/tasks/{task_id}/terminate
Timeout Task
POST/tasks/{task_id}/timeout
Query Task Workflow
GET/tasks/{task_id}/query/{query_name}
Interrupt Task
POST/tasks/{task_id}/interrupt
Messages
Create Message
POST/messages
List Messages
GET/messages
Update Message
PUT/messages/{message_id}
Get Message
GET/messages/{message_id}
List Messages Paginated
GET/messages/paginated
MessagesBatch
Batch Update Messages
PUT/messages/batch
Batch Create Messages
POST/messages/batch
Spans
Create Span
POST/spans
List Spans
GET/spans
Partial Update Span
PATCH/spans/{span_id}
Get Span
GET/spans/{span_id}
States
Create Task State
POST/states
List States
GET/states
Get State by State ID
GET/states/{state_id}
Update Task State
PUT/states/{state_id}
Delete Task State
DELETE/states/{state_id}
Events
Get Event
GET/events/{event_id}
List Events
GET/events
Tracker
Get Agent Task Tracker
GET/tracker/{tracker_id}
Update Agent Task Tracker
PUT/tracker/{tracker_id}
List Agent Task Trackers
GET/tracker
Deployment History
Get Deployment by ID
GET/deployment-history/{deployment_id}
List Deployments for an agent
GET/deployment-history
Checkpoints
Get Checkpoint Tuple
POST/checkpoints/get-tuple
Put Checkpoint
POST/checkpoints/put
Put Writes
POST/checkpoints/put-writes
List Checkpoints
POST/checkpoints/list
Delete Thread
POST/checkpoints/delete-thread
Webhooks
Create Webhook Trigger
POST/agent_api_keys/webhook-trigger