Skip to main content

List Batches

List all extraction batches with status, item counts, and provider information. Batches group documents submitted for deferred extraction at 50% cost.

Batch inference defers Claude extraction to the provider batch API at 50% cost. Documents uploaded with processing_mode=batch run OCR and classification immediately but queue extraction. Batches accumulate items, submit to the provider on a timer or threshold, and poll for results.

GET/v1/batches

Response

Response fields

dataarrayArray of batch objects.
data[].idstringBatch UUID.
data[].statusstringBatch status: accumulating, submitted, completed, failed, or cancelled.
data[].providerstringInference provider: anthropic or bedrock.
data[].item_countintegerTotal number of items (documents) in the batch.
data[].succeeded_countintegerNumber of items that completed successfully.
data[].errored_countintegerNumber of items that errored.
data[].expired_countintegerNumber of items that expired before processing.
data[].submitted_atstring | nullISO 8601 timestamp when the batch was submitted to the provider.
data[].completed_atstring | nullISO 8601 timestamp when the batch completed.
data[].error_messagestring | nullProvider error message if the batch failed.
data[].created_atstringISO 8601 creation timestamp.
data[].updated_atstringISO 8601 last update timestamp.
data[].links.selfstringURL to the batch detail endpoint.
pagination.totalintegerTotal number of batches matching the query.
pagination.limitintegerMaximum results per page.
pagination.has_morebooleanWhether more results exist beyond this page.
pagination.next_cursorstring | nullCursor to fetch the next page. Null if no more results.

Response

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "completed",
      "provider": "anthropic",
      "item_count": 142,
      "succeeded_count": 142,
      "errored_count": 0,
      "expired_count": 0,
      "submitted_at": "2024-10-01T06:00:00.000Z",
      "completed_at": "2024-10-01T14:23:00.000Z",
      "error_message": null,
      "created_at": "2024-10-01T05:45:00.000Z",
      "updated_at": "2024-10-01T14:23:00.000Z",
      "links": { "self": "/v1/batches/a1b2c3d4-e5f6-7890-abcd-ef1234567890" }
    }
  ],
  "pagination": {
    "total": 12,
    "limit": 20,
    "has_more": false,
    "next_cursor": null
  }
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Related

Batch Detail
Sync Batch