Retrieve a Message Batch changedapi/messages/batches/retrieve
Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
Recorded here
Lines+29added
Lines−14removed
From line
1
where the diff opens
First seen
14 Aug 2026
this site's first read of the page
Recorded edits6to this page, all time
# Retrieve a Message Batch ## Path parameters ## Returns ## Example ### Response (200) ## Retrieve a Message Batch ### Path Parameters ### Returns ### Example #### Response
The whole hunk
from line 1, old and new numbered
/
from line 1
1---
2title: Retrieve a Message Batch
3url: https://platform.claude.com/docs/en/api/messages/batches/retrieve
4---
1# Retrieve a Message Batch
52
6## Retrieve a Message Batch
3**GET** `/v1/messages/batches/{message_batch_id}`
74
8**get** `/v1/messages/batches/{message_batch_id}`
9
105This endpoint is idempotent and can be used to poll for Message Batch completion. To access the results of a Message Batch, make a request to the `results_url` field in the response.
116
127Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing)
138
14### Path Parameters
9## Path parameters
1510
1611- `message_batch_id: string`
1712
1813 ID of the Message Batch.
1914
20### Returns
15## Returns
2116
22- `MessageBatch object { id, archived_at, cancel_initiated_at, 7 more }`
17- `MessageBatch object`
2318
2419 - `id: string`
2520
from line 26
3126
3227 RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.
3328
29 format: date-time
30
3431 - `cancel_initiated_at: string or null`
3532
3633 RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated.
3734
35 format: date-time
36
3837 - `created_at: string`
3938
4039 RFC 3339 datetime string representing the time at which the Message Batch was created.
4140
41 format: date-time
42
4243 - `ended_at: string or null`
4344
4445 RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends.
from line 46
4546
4647 Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired.
4748
49 format: date-time
50
4851 - `expires_at: string`
4952
5053 RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation.
5154
55 format: date-time
56
5257 - `processing_status: "in_progress" or "canceling" or "ended"`
5358
5459 Processing status of the Message Batch.
from line 76
7176
7277 This is zero until processing of the entire Message Batch has ended.
7378
79 default: 0
80
7481 - `errored: number`
7582
7683 Number of requests in the Message Batch that encountered an error.
from line 84
7784
7885 This is zero until processing of the entire Message Batch has ended.
7986
87 default: 0
88
8089 - `expired: number`
8190
8291 Number of requests in the Message Batch that have expired.
from line 92
8392
8493 This is zero until processing of the entire Message Batch has ended.
8594
95 default: 0
96
8697 - `processing: number`
8798
8899 Number of requests in the Message Batch that are processing.
89100
101 default: 0
102
90103 - `succeeded: number`
91104
92105 Number of requests in the Message Batch that have completed successfully.
from line 106
93106
94107 This is zero until processing of the entire Message Batch has ended.
95108
109 default: 0
110
96111 - `results_url: string or null`
97112
98113 URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends.
from line 120
105120
106121 For Message Batches, this is always `"message_batch"`.
107122
108 - `"message_batch"`
123 default: message_batch
109124
110### Example
125## Example
111126
112```http
127```bash
113128curl https://api.anthropic.com/v1/messages/batches/$MESSAGE_BATCH_ID \
114129 -H 'anthropic-version: 2023-06-01' \
115130 -H "X-Api-Key: $ANTHROPIC_API_KEY"
116131```
117132
118#### Response
133### Response (200)
119134
120135```json
121136{
No line in this hunk matches that.