Skip to main content
POST
Cancel an agent run

Authorizations

Authorization
string
header
required

API key passed as Bearer token

Path Parameters

deployment_id
string
required

Agent deployment ID

run_id
string
required

Agent run ID

Body

application/json
reason
string | null

Response

Agent run cancellation recorded

id
string
required
Example:

"adrun_1234abcd"

deployment_id
string
required
version_id
string
required
mode
enum<string>
required
Available options:
job,
service
status
enum<string>
required
Available options:
queued,
starting,
installing,
running,
succeeded,
failed,
cancelled,
timed_out
input
object
required

Free-form run input supplied at run creation; passed through to the agent verbatim, deliberately open.

created_at
string<date-time>
required
updated_at
string<date-time>
required
retain_on_failure
boolean | null

Per-run override for failed job machine retention. Omit to use deployment debug config.

retention_seconds
integer<int64> | null

Retention TTL in seconds when the run is retained. Defaults to 3600 if retention is enabled without an explicit TTL.

Required range: x >= 1
machine_id
string | null
process_id
integer<uint32> | null
exit_code
integer | null
failure_reason
string | null
output_manifest
object | null

Output manifest produced by the agent runtime (typically containing an outputs array). Deliberately open: the manifest shape is owned by the agent, not the control plane.

started_at
string<date-time> | null
completed_at
string<date-time> | null
idempotency_key
string | null