The initiating actor or an Agent manager may cancel. Already terminal runs return a conflict and committed actions remain intact.
Path Parameters
workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
agent_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
run_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
Header Parameters
X-CSRF-TokenRequired
string·min 43·max 43
Session-bound CSRF token. It must exactly match the
__Host-assign_csrf cookie sent with the request.
Idempotency-KeyRequired
string·min 16·max 200
Opaque client-generated key for safely retrying this operation.
Request Body
application/json
Responses
idRequired
string <uuid>
Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
Example0198ac5e-f9b7-7000-8000-000000000001
workspace_idRequired
string <uuid>
Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
Example0198ac5e-f9b7-7000-8000-000000000001
agent_instance_idRequired
string <uuid>
Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
Example0198ac5e-f9b7-7000-8000-000000000001
definition_idRequired
string <uuid>
Stable Assign-owned identifier for a curated Agent definition. Definition identifiers are not resource UUIDv7 identifiers and clients must treat them as opaque.
Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
Example0198ac5e-f9b7-7000-8000-000000000001
scheduled_forRequired
string <date-time>
RFC 3339 timestamp in UTC.
Example2026-08-15T12:00:00Z
safe_summaryRequired
string·max 4000
error_codeRequired
string·min 1·max 100
Safe failure code. agent_resolution_exhausted indicates an unstarted dispatch exhausted resolution attempts and was reconciled; it does not imply an action occurred.
reserved_creditsRequired
integer <int64>·min 0
used_creditsRequired
integer <int64>·min 0
cancellation_requested_atRequired
string <date-time>
RFC 3339 timestamp in UTC.
Example2026-08-15T12:00:00Z
started_atRequired
string <date-time>
RFC 3339 timestamp in UTC.
Example2026-08-15T12:00:00Z
finished_atRequired
string <date-time>
RFC 3339 timestamp in UTC.
Example2026-08-15T12:00:00Z
created_atRequired
string <date-time>
RFC 3339 timestamp in UTC.
Example2026-08-15T12:00:00Z
updated_atRequired
string <date-time>
RFC 3339 timestamp in UTC.
Example2026-08-15T12:00:00Z
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
errorRequired
object
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
errorRequired
object
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
errorRequired
object
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
errorRequired
object
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
errorRequired
object
Retry-After
integer·min 0
Delay in seconds before retrying, when an expected maintenance end is known.
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
