v2

latestOpenAPI 3.1.02026-08-0858116535.1 KB

Agent

Cancel a run

Cancel a queued or running Agent run. If the run has already reached a terminal status, the API returns the existing run.

post/agent/runs/{id}/cancel

idstring required

Agent run ID. New run IDs are returned with the agent_run_ prefix.

Example:agent_run_01j7x9v0m2n4p6q8r0s2t4v6w8

Agent run ID.

Agent run

idstring required

Agent run ID. New run IDs are returned with the agent_run_ prefix.

object'agent_run' required

status'queued' | 'running' | 'completed' | 'failed' | 'cancelled' required

stopReason'schema_satisfied' | 'budget_reached' | 'error' | 'cancelled' required

createdAtstring date-time required

When the run was created

completedAtstring date-time nullable required