Anthropic API (unofficial showcase)
GET/v1/messages/batches/{message_batch_id}/results

Retrieve Message Batch results

Streams the results of a Message Batch as a .jsonl file.

Each line in the file is a JSON object containing the result of a single request in the Message Batch. Results are not guaranteed to be in the same order as requests. Use the custom_id field to match results to requests.

Learn more about the Message Batches API in our user guide

4 parameters
message_batch_idstringrequired
ID of the Message Batch.
anthropic-versionstringoptional
The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
x-api-keystringoptional
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](https://console.anthropic.com/settings/keys). Each key is scoped to a Workspace.
anthropic-workspace-idstringoptional
Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

17 status codes
200Successful Response
custom_idstringrequired
Developer-provided ID created for each request in a Message Batch. Useful for matching results to requests, as results may be given out of request order. Must be unique for each request within the Message Batch.
resultobjectrequired
Processing result for this request. Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration.
400Invalid argument - The client specified an invalid argument
errorobjectrequired
request_idstringrequired
Default:null
typestringrequired
Default:error
401Unauthenticated - The request does not have valid authentication credentials
errorobjectrequired
request_idstringrequired
Default:null
typestringrequired
Default:error
403Permission denied - The caller does not have permission to execute the specified operation
errorobjectrequired
request_idstringrequired
Default:null
typestringrequired
Default:error
404Not found - Some requested entity was not found
errorobjectrequired
request_idstringrequired
Default:null
typestringrequired
Default:error
408Deadline exceeded - The deadline expired before the operation could complete
errorobjectrequired
request_idstringrequired
Default:null
typestringrequired
Default:error
409Aborted - The operation was aborted due to concurrency issue
errorobjectrequired
request_idstringrequired
Default:null
typestringrequired
Default:error
412Failed precondition - Operation was rejected because the system is not in required state
errorobjectrequired
request_idstringrequired
Default:null
typestringrequired
Default:error
413Out of range - Operation was attempted past the valid range
errorobjectrequired
request_idstringrequired
Default:null
typestringrequired
Default:error
429Resource exhausted - Some resource has been exhausted (rate limiting)
errorobjectrequired
request_idstringrequired
Default:null
typestringrequired
Default:error
431Request header fields too large - Request metadata was too large
errorobjectrequired
request_idstringrequired
Default:null
typestringrequired
Default:error
499Cancelled - The operation was cancelled by the client
errorobjectrequired
request_idstringrequired
Default:null
typestringrequired
Default:error
500Internal - Internal server error
errorobjectrequired
request_idstringrequired
Default:null
typestringrequired
Default:error
501Unimplemented - The operation is not implemented or supported
errorobjectrequired
request_idstringrequired
Default:null
typestringrequired
Default:error
503Unavailable - The service is currently unavailable
errorobjectrequired
request_idstringrequired
Default:null
typestringrequired
Default:error
504Deadline exceeded - Upstream service did not respond in time
errorobjectrequired
request_idstringrequired
Default:null
typestringrequired
Default:error
529Overloaded - The service is temporarily overloaded
errorobjectrequired
request_idstringrequired
Default:null
typestringrequired
Default:error

Error handling

A 400 is returned: Invalid argument - The client specified an invalid argument. A 401 is returned: Unauthenticated - The request does not have valid authentication credentials. A 403 is returned: Permission denied - The caller does not have permission to execute the specified operation. A 404 is returned: Not found - Some requested entity was not found. A 408 is returned: Deadline exceeded - The deadline expired before the operation could complete. A 409 is returned: Aborted - The operation was aborted due to concurrency issue. A 412 is returned: Failed precondition - Operation was rejected because the system is not in required state. A 413 is returned: Out of range - Operation was attempted past the valid range. A 429 is returned: Resource exhausted - Some resource has been exhausted (rate limiting). A 431 is returned: Request header fields too large - Request metadata was too large. A 499 is returned: Cancelled - The operation was cancelled by the client. A 500 is returned: Internal - Internal server error. A 501 is returned: Unimplemented - The operation is not implemented or supported. A 503 is returned: Unavailable - The service is currently unavailable. A 504 is returned: Deadline exceeded - Upstream service did not respond in time. A 529 is returned: Overloaded - The service is temporarily overloaded.