## List Message Batches ### Query Parameters ### Returns ### Example #### Response
The whole hunk
168 lines, first recorded
/
lines
The first capture of this source. The page was already there, and this is what it said.
---
title: List Message Batches
url: https://platform.claude.com/docs/en/api/messages/batches/list
---
## List Message Batches
**get** `/v1/messages/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](https://platform.claude.com/docs/en/build-with-claude/batch-processing)
### Query Parameters
- `after_id: optional string`
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.
- `before_id: optional string`
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.
- `limit: optional number`
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
### Returns
- `data: array of MessageBatch`
- `id: string`
Unique object identifier.
The format and length of IDs may change over time.
- `archived_at: string or null`
RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.
- `cancel_initiated_at: string or null`
RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated.
- `created_at: string`
RFC 3339 datetime string representing the time at which the Message Batch was created.
- `ended_at: string or null`
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.
- `expires_at: string`
RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation.
- `processing_status: "in_progress" or "canceling" or "ended"`
Processing status of the Message Batch.
- `"in_progress"`
- `"canceling"`
- `"ended"`
- `request_counts: MessageBatchRequestCounts`
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.
- `canceled: number`
Number of requests in the Message Batch that have been canceled.
This is zero until processing of the entire Message Batch has ended.
- `errored: number`
Number of requests in the Message Batch that encountered an error.
This is zero until processing of the entire Message Batch has ended.
- `expired: number`
Number of requests in the Message Batch that have expired.
This is zero until processing of the entire Message Batch has ended.
- `processing: number`
Number of requests in the Message Batch that are processing.
- `succeeded: number`
Number of requests in the Message Batch that have completed successfully.
This is zero until processing of the entire Message Batch has ended.
- `results_url: string or null`
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.
- `type: "message_batch"`
Object type.
For Message Batches, this is always `"message_batch"`.
- `"message_batch"`
- `first_id: string or null`
First ID in the `data` list. Can be used as the `before_id` for the previous page.
- `has_more: boolean`
Indicates if there are more results in the requested page direction.
- `last_id: string or null`
Last ID in the `data` list. Can be used as the `after_id` for the next page.
### Example
```http
curl https://api.anthropic.com/v1/messages/batches \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response
```json
{
"data": [
{
"id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
"archived_at": "2024-08-20T18:37:24.100435Z",
"cancel_initiated_at": "2024-08-20T18:37:24.100435Z",
"created_at": "2024-08-20T18:37:24.100435Z",
"ended_at": "2024-08-20T18:37:24.100435Z",
"expires_at": "2024-08-20T18:37:24.100435Z",
"processing_status": "in_progress",
"request_counts": {
"canceled": 10,
"errored": 30,
"expired": 10,
"processing": 100,
"succeeded": 50
},
"results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results",
"type": "message_batch"
}
],
"first_id": "first_id",
"has_more": true,
"last_id": "last_id"
}
```