Intents

Cancel an intent

Cancel an intent before execution starts.

POST/v1/agent-api/intents/{intentId}/cancel

Path parameters

intentIdstringRequired

Responses

200
Full intent state after cancellation. Repeating the request for an already-cancelled intent returns the same successful projection. Cancellation is only available before execution starts and cannot stop or reverse work already executing.
404
Intent missing or not owned by the authenticated agent (intent_not_found)
409
Intent is not eligible for cancellation (intent_not_cancellable)

Response fields

idstringRequired
accountIdstringOptional
Resolved source account, pinned when the intent was created. Omitted for actions without an account.
type"send" | "transfer" | "create_counterparty" | "request_counterparty_details" | "x402" | "mpp" | "policy_override"Required
status"pending" | "processing" | "completed" | "blocked" | "failed"Required
resolution"completed" | "blocked" | "denied" | "expired" | "failed" | "cancelled" or string or nullRequired
Exact terminal outcome, or null while the intent is nonterminal. Known values are completed, blocked, denied, expired, failed, and cancelled; clients must preserve future nonblank strings.
reasonsarray of stringRequired
expiresAtstring or nullRequired
movementobjectOptional
movement.planIdstringRequired
movement.nextStep"wait" | "done" | "blocked"Required
dataobject or nullRequired
metadataobjectRequired
metadata.dataUrlstring or nullRequired
Updated October 29, 2026 Generated from the agent API's published OpenAPI document View as Markdown