EXexa
Batches

Cancel a batch

Changed on

Request cancellation of a batch. The batch stops scheduling new requests and drains in-flight work before settling to cancelled. Cancelling a batch that is already cancelling or cancelled is idempotent and returns the batch unchanged. A batch that has already reached a terminal status (completed or expired) cannot be cancelled and the request fails with a 409.

post/batches/{id}/cancel

Request

  • Base URL
    https://api.exa.ai
  • URL
    https://api.exa.ai/batches/{id}/cancel
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

idstring required

Batch ID.

Headers

Exa-Beta'batches-2026-06-06' required

Required beta token for the Batch API.

Response

OK

idstring required

Batch ID. New batch IDs are returned with the batch_ prefix.

object'batch' required

The object type, always batch.

status'in_progress' | 'completed' | 'cancelling' | 'cancelled' | 'expired' required

Lifecycle status of the batch.

createdAtstring date-time required

When the batch was created.

expiresAtstring date-time nullable required

When the batch expires, or null if it does not expire.

endedAtstring date-time nullable required

When the batch reached a terminal status, or null while it is still running.

resultsUrlstring nullable required

Short-lived download URL for the batch results file (JSONL), or null until the batch completes. Fetch it directly, without an API key. Retrieve the batch again for a fresh URL after it expires.

metadataobject required

Caller-provided key-value metadata for your own tracking.

Changes

  • 9836dac5075aRevision changes
    • info

      added the non-success response with the status

  • 67abccbd77b6Revision changes
    • warning

      deleted the header request parameter Exa-Version

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status