Retrieve a Message Batch changedapi/beta/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+34added
Lines−19removed
From line
1
where the diff opens
First seen
14 Aug 2026
this site's first read of the page
Recorded edits17to this page, all time
# Retrieve a Message Batch ## Path parameters ## Headers ## Returns ## Example ### Response (200) ## Retrieve a Message Batch ### Path Parameters ### Header 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/beta/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### Header Parameters
15## Headers
2116
2217- `"anthropic-beta": optional array of AnthropicBeta`
2318
from line 90
9590
9691 - `"mid-conversation-tool-changes-2026-07-01"`
9792
98### Returns
93## Returns
9994
100- `BetaMessageBatch object { id, archived_at, cancel_initiated_at, 7 more }`
95- `BetaMessageBatch object`
10196
10297 - `id: string`
10398
from line 104
109104
110105 RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.
111106
107 format: date-time
108
112109 - `cancel_initiated_at: string or null`
113110
114111 RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated.
115112
113 format: date-time
114
116115 - `created_at: string`
117116
118117 RFC 3339 datetime string representing the time at which the Message Batch was created.
119118
119 format: date-time
120
120121 - `ended_at: string or null`
121122
122123 RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends.
from line 124
123124
124125 Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired.
125126
127 format: date-time
128
126129 - `expires_at: string`
127130
128131 RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation.
129132
133 format: date-time
134
130135 - `processing_status: "in_progress" or "canceling" or "ended"`
131136
132137 Processing status of the Message Batch.
from line 154
149154
150155 This is zero until processing of the entire Message Batch has ended.
151156
157 default: 0
158
152159 - `errored: number`
153160
154161 Number of requests in the Message Batch that encountered an error.
from line 162
155162
156163 This is zero until processing of the entire Message Batch has ended.
157164
165 default: 0
166
158167 - `expired: number`
159168
160169 Number of requests in the Message Batch that have expired.
from line 170
161170
162171 This is zero until processing of the entire Message Batch has ended.
163172
173 default: 0
174
164175 - `processing: number`
165176
166177 Number of requests in the Message Batch that are processing.
167178
179 default: 0
180
168181 - `succeeded: number`
169182
170183 Number of requests in the Message Batch that have completed successfully.
from line 184
171184
172185 This is zero until processing of the entire Message Batch has ended.
173186
187 default: 0
188
174189 - `results_url: string or null`
175190
176191 URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends.
from line 198
183198
184199 For Message Batches, this is always `"message_batch"`.
185200
186 - `"message_batch"`
201 default: message_batch
187202
188### Example
203## Example
189204
190```http
205```bash
191206curl https://api.anthropic.com/v1/messages/batches/$MESSAGE_BATCH_ID \
192207 -H 'anthropic-version: 2023-06-01' \
193208 -H 'anthropic-beta: message-batches-2024-09-24' \
from line 209
194209 -H "X-Api-Key: $ANTHROPIC_API_KEY"
195210```
196211
197#### Response
212### Response (200)
198213
199214```json
200215{
No line in this hunk matches that.