Cancel a run

Cancel a queued or running Agent run.

POST /agent/runs/{id}/cancel

Cancel a run

cURL

curl --request POST \
  --url https://api.exa.ai/agent/runs/{id}/cancel \
  --header 'x-api-key: <api-key>'

200

{
  "id": "agent_run_01j7x9v0m2n4p6q8r0s2t4v6w8",
  "object": "agent_run",
  "status": "queued",
  "stopReason": "schema_satisfied",
  "createdAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "request": {
    "query": "What are the most important AI infrastructure funding rounds announced this week?",
    "systemPrompt": "Prefer official sources and avoid duplicate results.",
    "input": {
      "data": [
        {}
      ],
      "exclusion": [
        {}
      ]
    },
    "outputSchema": {},
    "effort": "auto",
    "previousRunId": "agent_run_01j7x9v0m2n4p6q8r0s2t4v6w8",
    "metadata": {
      "slack_channel_id": "C123ABC",
      "slack_thread_id": "1745444400.123456",
      "user_id": "U123ABC"
    },
    "dataSources": [
      {
        "provider": "fiber"
      }
    ],
    "budget": {
      "maxCostDollars": 10
    }
  },
  "output": {
    "text": "<string>",
    "structured": true,
    "grounding": [
      {
        "field": "structured.companies[0].sourceUrl",
        "citations": [
          {
            "url": "<string>",
            "title": "<string>"
          }
        ],
        "confidence": "low"
      }
    ]
  },
  "usage": {
    "agentComputeUnits": 1,
    "searches": 1,
    "emails": 1,
    "phoneNumbers": 1,
    "dataSources": {}
  },
  "costDollars": {
    "total": 1,
    "agentCompute": 1,
    "search": 1,
    "emails": 1,
    "phoneNumbers": 1,
    "dataSources": {}
  }
}

If the run is still active, it transitions to cancelled immediately and terminates without returning any results. The run ends with status cancelled and stopReason: cancelled. You are billed for usage accrued before cancellation. If the run has already reached a terminal status (completed, failed, or cancelled), the endpoint returns the existing run unchanged.

Get your Exa API key

Authorizations

apiKeybearer

x-api-key · string · header · required

Pass your Exa API key in the x-api-key header. You can also authenticate with Authorization: Bearer .

Path Parameters

id · string · required

Agent run ID.

Required string length: 1 - 200

Pattern: ^[A-Za-z0-9_.:-]+$

Example:

"agent_run_01j7x9v0m2n4p6q8r0s2t4v6w8"

Response

200

application/json

Agent run

id · string · required

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

Required string length: 1 - 200

Pattern: ^[A-Za-z0-9_.:-]+$

Example:

"agent_run_01j7x9v0m2n4p6q8r0s2t4v6w8"

object · string · required

Allowed value: "agent_run"

status · enum<string> · required

Available options: queued, running, completed, failed, cancelled

stopReason · enum<string> | null · required

Why the run stopped. null while the run is queued or running.

Available options: schema_satisfied, budget_reached, stopped, error, cancelled

createdAt · string<date-time> · required

When the run was created

completedAt · string<date-time> · required

request · object | null · required

Canonicalized request fields stored with the run.

Show child attributes

output · object · required

Show child attributes

usage · object · required

Show child attributes

costDollars · object · required

Show child attributes