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
ParametersExpand Collapse
ID of the Message Batch.
params: BatchResultsParams { betas }
Optional 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" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 15 more
ReturnsExpand Collapse
BetaMessageBatchIndividualResponse { 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.
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.
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.
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.
BetaMessageBatchSucceededResult { message, type }
Unique object identifier.
The format and length of IDs may change over time.
Information about the container used in the request (for the code execution tool)
Information about the container used in the request (for the code execution tool)
Identifier for the container used in this request
The time at which the container will expire.
Skills loaded in the container
Skills loaded in the container
Skill ID
type: "anthropic" | "custom"Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Skill version or 'latest' for most recent version
Content generated by the model.
This is an array of content blocks, each of which has a type that determines its shape.
Example:
[{"type": "text", "text": "Hi, I'm Claude."}]
If the request input messages ended with an assistant turn, then the response content will continue directly from that last turn. You can use this to constrain the model's output.
For example, if the input messages were:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("}
]
Then the response content might be:
[{"type": "text", "text": "B)"}]
Content generated by the model.
This is an array of content blocks, each of which has a type that determines its shape.
Example:
[{"type": "text", "text": "Hi, I'm Claude."}]
If the request input messages ended with an assistant turn, then the response content will continue directly from that last turn. You can use this to constrain the model's output.
For example, if the input messages were:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("}
]
Then the response content might be:
[{"type": "text", "text": "B)"}]
BetaTextBlock { citations, text, type }
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: "char_location"
BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: "page_location"
BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: "content_block_location"
BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: "web_search_result_location"
BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: "search_result_location"
type: "text"
BetaThinkingBlock { signature, thinking, type }
type: "thinking"
BetaRedactedThinkingBlock { data, type }
type: "redacted_thinking"
BetaToolUseBlock { id, input, name, type }
type: "tool_use"
BetaServerToolUseBlock { id, input, name, type }
name: "web_search" | "web_fetch" | "code_execution" | 2 more
type: "server_tool_use"
BetaWebSearchToolResultBlock { content, tool_use_id, type }
BetaWebSearchToolResultError { error_code, type }
type: "web_search_tool_result_error"
Array<BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more } >
type: "web_search_result"
type: "web_search_tool_result"
BetaWebFetchToolResultBlock { content, tool_use_id, type }
content: BetaWebFetchToolResultErrorBlock { error_code, type } | BetaWebFetchBlock { content, retrieved_at, type, url }
BetaWebFetchToolResultErrorBlock { error_code, type }
type: "web_fetch_tool_result_error"
BetaWebFetchBlock { content, retrieved_at, type, url }
Citation configuration for the document
Citation configuration for the document
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type }
BetaBase64PDFSource { data, media_type, type }
media_type: "application/pdf"
type: "base64"
BetaPlainTextSource { data, media_type, type }
media_type: "text/plain"
type: "text"
The title of the document
type: "document"
ISO 8601 timestamp when the content was retrieved
type: "web_fetch_result"
Fetched content URL
type: "web_fetch_tool_result"
BetaCodeExecutionToolResultBlock { content, tool_use_id, type }
BetaCodeExecutionToolResultError { error_code, type }
type: "code_execution_tool_result_error"
BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }
type: "code_execution_output"
type: "code_execution_result"
type: "code_execution_tool_result"
BetaBashCodeExecutionToolResultBlock { content, tool_use_id, type }
content: BetaBashCodeExecutionToolResultError { error_code, type } | BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
BetaBashCodeExecutionToolResultError { error_code, type }
error_code: "invalid_tool_input" | "unavailable" | "too_many_requests" | 2 more
type: "bash_code_execution_tool_result_error"
BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
type: "bash_code_execution_output"
type: "bash_code_execution_result"
type: "bash_code_execution_tool_result"
BetaTextEditorCodeExecutionToolResultBlock { content, tool_use_id, type }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } | BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } | BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } | BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type }
error_code: "invalid_tool_input" | "unavailable" | "too_many_requests" | 2 more
type: "text_editor_code_execution_tool_result_error"
BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more }
file_type: "text" | "image" | "pdf"
type: "text_editor_code_execution_view_result"
BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type }
type: "text_editor_code_execution_create_result"
BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
type: "text_editor_code_execution_str_replace_result"
type: "text_editor_code_execution_tool_result"
BetaMCPToolUseBlock { id, input, name, 2 more }
The name of the MCP tool
The name of the MCP server
type: "mcp_tool_use"
BetaMCPToolResultBlock { content, is_error, tool_use_id, type }
Array<BetaTextBlock { citations, text, type } >
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: "char_location"
BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: "page_location"
BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: "content_block_location"
BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: "web_search_result_location"
BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: "search_result_location"
type: "text"
type: "mcp_tool_result"
BetaContainerUploadBlock { file_id, type } Response model for a file uploaded to the container.
Response model for a file uploaded to the container.
type: "container_upload"
Context management response.
Information about context management strategies applied during the request.
Context management response.
Information about context management strategies applied during the request.
applied_edits: Array<BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } | BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type } >List of context management edits that were applied.
List of context management edits that were applied.
BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type }
Number of input tokens cleared by this edit.
Number of tool uses that were cleared.
type: "clear_tool_uses_20250919"The type of context management edit applied.
The type of context management edit applied.
BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }
Number of input tokens cleared by this edit.
Number of thinking turns that were cleared.
type: "clear_thinking_20251015"The type of context management edit applied.
The type of context management edit applied.
"claude-3-7-sonnet-latest" | "claude-3-7-sonnet-20250219" | "claude-3-5-haiku-latest" | 15 more
High-performance model with early extended thinking
High-performance model with early extended thinking
Fastest and most compact model for near-instant responsiveness
Our fastest model
Hybrid model, capable of near-instant responses and extended thinking
Hybrid model, capable of near-instant responses and extended thinking
High-performance model with extended thinking
High-performance model with extended thinking
High-performance model with extended thinking
Our best model for real-world agents and coding
Our best model for real-world agents and coding
Our most capable model
Our most capable model
Our most capable model
Our most capable model
Excels at writing and complex tasks
Excels at writing and complex tasks
Our previous most fast and cost-effective
role: "assistant"Conversational role of the generated message.
This will always be "assistant".
Conversational role of the generated message.
This will always be "assistant".
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requested max_tokens or the model's maximum"stop_sequence": one of your provided custom stop_sequences was generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
Which custom stop sequence was generated, if any.
This value will be a non-null string if one of your custom stop sequences was generated.
type: "message"Object type.
For Messages, this is always "message".
Object type.
For Messages, this is always "message".
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
Breakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
The number of server tool requests.
The number of server tool requests.
The number of web fetch tool requests.
The number of web search tool requests.
service_tier: "standard" | "priority" | "batch" | nullIf the request used the priority, standard, or batch tier.
If the request used the priority, standard, or batch tier.
type: "succeeded"
BetaMessageBatchErroredResult { error, type }
BetaInvalidRequestError { message, type }
type: "invalid_request_error"
BetaAuthenticationError { message, type }
type: "authentication_error"
BetaBillingError { message, type }
type: "billing_error"
BetaPermissionError { message, type }
type: "permission_error"
BetaNotFoundError { message, type }
type: "not_found_error"
BetaRateLimitError { message, type }
type: "rate_limit_error"
BetaGatewayTimeoutError { message, type }
type: "timeout_error"
BetaAPIError { message, type }
type: "api_error"
BetaOverloadedError { message, type }
type: "overloaded_error"
type: "error"
type: "errored"
BetaMessageBatchCanceledResult { type }
type: "canceled"
BetaMessageBatchExpiredResult { type }
type: "expired"
Retrieve Message Batch results
import Anthropic from '@anthropic-ai/sdk';
const client = new Anthropic({
apiKey: 'my-anthropic-api-key',
});
const betaMessageBatchIndividualResponse = await client.beta.messages.batches.results('message_batch_id');
console.log(betaMessageBatchIndividualResponse.custom_id);