Cancel a run

cURL

curl -X POST https://api.exa.ai/agent/runs/<id>/cancel \
  -H "x-api-key: $EXA_API_KEY"

{
  "id": "<string>",
  "object": "agent_run",
  "status": "queued",
  "stopReason": "schema_satisfied",
  "createdAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "request": {
    "query": "<string>",
    "systemPrompt": "<string>",
    "effort": "auto",
    "input": {
      "data": [
        {}
      ],
      "exclusion": [
        {}
      ]
    },
    "outputSchema": {},
    "previousRunId": "<string>",
    "metadata": {},
    "dataSources": [
      {
        "provider": "<string>"
      }
    ],
    "budget": {
      "maxCostDollars": 123,
      "maxDurationSeconds": 123
    }
  },
  "error": {
    "type": "INVALID_REQUEST",
    "code": "INVALID_REQUEST",
    "message": "<string>"
  },
  "output": {
    "text": "<string>",
    "structured": true,
    "grounding": [
      {
        "field": "<string>",
        "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": {}
  }
}

{
  "error": {
    "type": "INVALID_REQUEST",
    "code": "INVALID_REQUEST",
    "message": "<string>"
  }
}

{
  "error": {
    "type": "INVALID_REQUEST",
    "code": "INVALID_REQUEST",
    "message": "<string>"
  }
}

{
  "requestId": "<string>",
  "error": "<string>",
  "tag": "<string>"
}

{
  "requestId": "<string>",
  "error": "<string>",
  "tag": "<string>"
}

{
  "error": {
    "type": "INVALID_REQUEST",
    "code": "INVALID_REQUEST",
    "message": "<string>"
  }
}

{
  "error": {
    "type": "INVALID_REQUEST",
    "code": "INVALID_REQUEST",
    "message": "<string>"
  }
}

{
  "error": {
    "type": "INVALID_REQUEST",
    "code": "INVALID_REQUEST",
    "message": "<string>"
  }
}

cURL

curl -X POST https://api.exa.ai/agent/runs/<id>/cancel \
  -H "x-api-key: $EXA_API_KEY"

{
  "id": "<string>",
  "object": "agent_run",
  "status": "queued",
  "stopReason": "schema_satisfied",
  "createdAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "request": {
    "query": "<string>",
    "systemPrompt": "<string>",
    "effort": "auto",
    "input": {
      "data": [
        {}
      ],
      "exclusion": [
        {}
      ]
    },
    "outputSchema": {},
    "previousRunId": "<string>",
    "metadata": {},
    "dataSources": [
      {
        "provider": "<string>"
      }
    ],
    "budget": {
      "maxCostDollars": 123,
      "maxDurationSeconds": 123
    }
  },
  "error": {
    "type": "INVALID_REQUEST",
    "code": "INVALID_REQUEST",
    "message": "<string>"
  },
  "output": {
    "text": "<string>",
    "structured": true,
    "grounding": [
      {
        "field": "<string>",
        "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": {}
  }
}

{
  "error": {
    "type": "INVALID_REQUEST",
    "code": "INVALID_REQUEST",
    "message": "<string>"
  }
}

{
  "error": {
    "type": "INVALID_REQUEST",
    "code": "INVALID_REQUEST",
    "message": "<string>"
  }
}

{
  "requestId": "<string>",
  "error": "<string>",
  "tag": "<string>"
}

{
  "requestId": "<string>",
  "error": "<string>",
  "tag": "<string>"
}

{
  "error": {
    "type": "INVALID_REQUEST",
    "code": "INVALID_REQUEST",
    "message": "<string>"
  }
}

{
  "error": {
    "type": "INVALID_REQUEST",
    "code": "INVALID_REQUEST",
    "message": "<string>"
  }
}

{
  "error": {
    "type": "INVALID_REQUEST",
    "code": "INVALID_REQUEST",
    "message": "<string>"
  }
}

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

Create a key in the dashboard. New accounts start with free credits.

Authorizations

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

string

required

Agent run ID.

Required string length: 1 - 200

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

Response

Agent run

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_.:-]+$

object

string

required

Allowed value: "agent_run"

status

enum<string>

required

Available options:

queued,

running,

completed,

failed,

cancelled

stopReason

required

Why the run stopped. null while the run is queued or running. Every reason except error and cancelled means the run completed and returned what it found. Clients should accept values not listed here.

Allowed value: "schema_satisfied"

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

error

object | null

required

Why the run failed. null unless status is failed.

Show child attributes

output

object

required

Show child attributes

usage

object

required

Billed usage for the run. When an auto or ultra run's metered cost exceeds budget.maxCostDollars, the run is billed the budget and each quantity except dataSources is scaled down in proportion, so quantities can be fractional.

Show child attributes

costDollars

object

required

Show child attributes

Search

Contents

Agent

Monitors

Answer

Batch

Team Management

Websets

Cancel a run

Get your Exa API key

Authorizations

Path Parameters

Response