Cancel Agent Run

Cancel a currently executing agent run. This will attempt to stop the agent’s execution gracefully.

Note: Cancellation may not be immediate for all operations.

POST /agents/{agent_id}/runs/{run_id}/cancel

Cancel Agent Run

cURL

curl --request POST \
  --url https://api.example.com/agents/{agent_id}/runs/{run_id}/cancel \
  --header 'Authorization: Bearer <token>'

400

{
  "detail": "Bad request",
  "error_code": "BAD_REQUEST"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agent_id · string · required

run_id · string · required

Response

200

application/json

Successful Response