List Message Batches

List all Message Batches within a Workspace. Most recently created batches are returned first.

Learn more about the Message Batches API in our user guide

GET /v1/messages/batches

cURL

cURL

curl https://api.anthropic.com/v1/messages/batches \
     --header "x-api-key: $ANTHROPIC_API_KEY" \
     --header "anthropic-version: 2023-06-01"

200

{
  "data": [
    {
      "archived_at": "2024-08-20T18:37:24.100435Z",
      "cancel_initiated_at": "2024-08-20T18:37:24.100435Z",
      "created_at": "2023-11-07T05:31:56Z",
      "ended_at": "2024-08-20T18:37:24.100435Z",
      "expires_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "processing_status": "in_progress",
      "request_counts": {
        "canceled": 0,
        "errored": 0,
        "expired": 0,
        "processing": 0,
        "succeeded": 0
      },
      "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results",
      "type": "message_batch"
    }
  ],
  "first_id": "<string>",
  "has_more": true,
  "last_id": "<string>"
}

Headers

anthropic-beta · string[]

Optional header to specify the beta version(s) you want to use.

To use multiple betas, use a comma separated list like beta1,beta2 or specify the header multiple times for each beta.

anthropic-version · string · required

The version of the Claude API you want to use.

Read more about versioning and our version history here.

x-api-key · string · required

Your unique API key for authentication.

This key is required in the header of all API requests, to authenticate your account and access Anthropic's services. Get your API key through the Console. Each key is scoped to a Workspace.

Query Parameters

before_id · string

ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.

after_id · string

ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.

limit · integer · default: 20

Number of items to return per page.

Defaults to 20. Ranges from 1 to 1000.

Required range: 1 <= x <= 1000

Response

200

application/json

Successful Response

data · MessageBatch · object[] · required

Show child attributes

data. archived_at · string<date-time> | null · required

RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.

Example:

"2024-08-20T18:37:24.100435Z"

data. cancel_initiated_at · string<date-time> | null · required

RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated.

Example:

"2024-08-20T18:37:24.100435Z"

data. created_at · string<date-time> · required

RFC 3339 datetime string representing the time at which the Message Batch was created.

data. ended_at · string<date-time> | null · required

RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends.

Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired.

Example:

"2024-08-20T18:37:24.100435Z"

data. expires_at · string<date-time> · required

RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation.

data. id · string · required

Unique object identifier.

The format and length of IDs may change over time.

data. processing_status · enum<string> · required

Processing status of the Message Batch.

Available options: in_progress, canceling, ended

data. request_counts · RequestCounts · object · required

Tallies requests within the Message Batch, categorized by their status.

Requests start as processing and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch.

Show child attributes

data.request_counts. canceled · integer · default: 0 · required

Number of requests in the Message Batch that have been canceled.

This is zero until processing of the entire Message Batch has ended.

data.request_counts. errored · integer · default: 0 · required

Number of requests in the Message Batch that encountered an error.

This is zero until processing of the entire Message Batch has ended.

data.request_counts. expired · integer · default: 0 · required

Number of requests in the Message Batch that have expired.

This is zero until processing of the entire Message Batch has ended.

data.request_counts. processing · integer · default: 0 · required

Number of requests in the Message Batch that are processing.

data.request_counts. succeeded · integer · default: 0 · required

Number of requests in the Message Batch that have completed successfully.

This is zero until processing of the entire Message Batch has ended.

data. results_url · string | null · required

URL to a .jsonl file containing the results of the Message Batch requests. Specified only once processing ends.

Results in the file are not guaranteed to be in the same order as requests. Use the custom_id field to match results to requests.

Example:

"https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results"

data. type · string · default: message_batch · required

Object type.

For Message Batches, this is always "message_batch".

Allowed value: "message_batch"

first_id · string | null · required

First ID in the data list. Can be used as the before_id for the previous page.

has_more · boolean · required

Indicates if there are more results in the requested page direction.

last_id · string | null · required

Last ID in the data list. Can be used as the after_id for the next page.