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
Parameters
ID of the Message Batch.
--beta: optional array of AnthropicBetaHeader parameterOptional header to specify the beta version(s) you want to use.
Optional header to specify the beta version(s) you want to use.
"message-batches-2024-09-24"Deprecated
"prompt-caching-2024-07-31"Deprecated
"pdfs-2024-09-25"Deprecated
"token-counting-2024-11-01"Deprecated
"token-efficient-tools-2025-02-19"Deprecated
"files-api-2025-04-14"Deprecated
"extended-cache-ttl-2025-04-11"Deprecated
"skills-2025-10-02"Deprecated
"cache-diagnosis-2026-04-07"Deprecated
"ce-user-management-2026-07-13"Deprecated
--workspace-id: optional stringHeader parameterOptional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).
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.
Returns
beta_message_batch_individual_response: object{ custom_id, result }This is a single line in the response .jsonl file and does not represent the response as a whole.
This is a single line in the response .jsonl file and does not represent the response as a whole.
custom_id: stringDeveloper-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.
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.
result: BetaMessageBatchSucceededResult or BetaMessageBatchErroredResult or BetaMessageBatchCanceledResult or BetaMessageBatchExpiredResultProcessing result for this request.
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.
Errors
Any method can also return the general HTTP errors.
Each code below is the value of error.details.error_code in the response body.
The API key belongs to the Claude Code workspace, and the user who created it is no longer a member of the organization or of that workspace.
The workspace's customer-managed encryption key is disabled or revoked. Re-enable the key, then retry.
Anthropic has disabled the organization for trust and safety reasons. An organization disabled for any other reason, such as billing, does not get this code. appeal_url, when present, is where the organization can appeal.
ant beta:messages:batches results \
--message-batch-id message_batch_id