One change
Retrieve Message Batch results
api/beta/messages/batches/results
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.
api/beta/messages/batches/results Changed · +363 / -236 lines
# Retrieve Message Batch results ## Path parameters ## Headers ## Returns ## Example ## Retrieve Message Batch results ### Path Parameters ### Header Parameters ### Returns ### Example
The two sides of this change are too far apart to line up, so this is the differ's own diff of it.
from line 1
---- -title: Retrieve Message Batch results -url: https://platform.claude.com/docs/en/api/beta/messages/batches/results ---- - -## Retrieve Message Batch results - -**get** `/v1/messages/batches/{message_batch_id}/results` +# Retrieve Message Batch results + +**GET** `/v1/messages/batches/{message_batch_id}/results` Streams the results of a Message Batch as a `.jsonl` file.
from line 8
Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing) -### Path Parameters +## Path parameters - `message_batch_id: string` ID of the Message Batch. -### Header Parameters +## Headers - `"anthropic-beta": optional array of AnthropicBeta`
from line 92
- `"mid-conversation-tool-changes-2026-07-01"` -### Returns - -- `BetaMessageBatchIndividualResponse object { custom_id, result }` +## Returns + +- `BetaMessageBatchIndividualResponse object` This is a single line in the response `.jsonl` file and does not represent the response as a whole.
from line 110
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 object { message, type }` + - `BetaMessageBatchSucceededResult object` - `message: BetaMessage`
from line 132
The time at which the container will expire. + format: date-time + - `skills: array of BetaSkill or null` Skills loaded in the container
from line 142
Skill ID + maxLength: 64, minLength: 1 + - `type: "anthropic" or "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
from line 155
- `version: string` The resolved version: a skill version ID for custom skills. + + maxLength: 64, minLength: 1 - `content: array of BetaContentBlock`
from line 187
[{"type": "text", "text": "B)"}] ``` - - `BetaTextBlock object { citations, text, type }` + - `BetaTextBlock object` - `citations: array of BetaTextCitation or null`
from line 195
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 object { cited_text, document_index, document_title, 4 more }` + - `BetaCitationCharLocation object` - `cited_text: string` - `document_index: number` + minimum: 0 + - `document_title: string or null` - `end_char_index: number`
from line 211
- `start_char_index: number` + minimum: 0 + - `type: "char_location"` - - `"char_location"` - - - `BetaCitationPageLocation object { cited_text, document_index, document_title, 4 more }` + default: char_location + + - `BetaCitationPageLocation object` - `cited_text: string` - `document_index: number` + minimum: 0 + - `document_title: string or null` - `end_page_number: number`
from line 233
- `start_page_number: number` + minimum: 1 + - `type: "page_location"` - - `"page_location"` - - - `BetaCitationContentBlockLocation object { cited_text, document_index, document_title, 4 more }` + default: page_location + + - `BetaCitationContentBlockLocation object` - `cited_text: string`
from line 249
- `document_index: number` + minimum: 0 + - `document_title: string or null` - `end_block_index: number`
from line 265
0-based index of the first cited block in the source's `content` array. + minimum: 0 + - `type: "content_block_location"` - - `"content_block_location"` - - - `BetaCitationsWebSearchResultLocation object { cited_text, encrypted_index, title, 2 more }` + default: content_block_location + + - `BetaCitationsWebSearchResultLocation object` - `cited_text: string`
from line 279
- `title: string or null` + maxLength: 512 + - `type: "web_search_result_location"` - - `"web_search_result_location"` + default: web_search_result_location - `url: string` - - `BetaCitationSearchResultLocation object { cited_text, end_block_index, search_result_index, 4 more }` + - `BetaCitationSearchResultLocation object` - `cited_text: string`
from line 307
Counted separately from `document_index`; server-side web search results are not included in this count. + minimum: 0 + - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. + minimum: 0 + - `title: string or null` - `type: "search_result_location"` - - `"search_result_location"` + default: search_result_location - `text: string` + maxLength: 5000000, minLength: 0 + - `type: "text"` - - `"text"` - - - `BetaThinkingBlock object { signature, thinking, type }` + default: text + + - `BetaThinkingBlock object` - `signature: string`
from line 347
- `type: "thinking"` - - `"thinking"` - - - `BetaRedactedThinkingBlock object { data, type }` + default: thinking + + - `BetaRedactedThinkingBlock object` - `data: string`
from line 361
- `type: "redacted_thinking"` - - `"redacted_thinking"` - - - `BetaToolUseBlock object { id, input, name, 3 more }` + default: redacted_thinking + + - `BetaToolUseBlock object` - `id: string` + pattern: ^[a-zA-Z0-9_-]+$ + - `input: map[unknown]` - `name: string` + minLength: 1 + - `type: "tool_use"` - - `"tool_use"` + default: tool_use - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - - `BetaDirectCaller object { type }` + - `BetaDirectCaller object` Tool invocation directly from the model. - `type: "direct"` - - `"direct"` - - - `BetaServerToolCaller object { tool_id, type }` + - `BetaServerToolCaller object` Tool invocation generated by a server-side tool. - `tool_id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `type: "code_execution_20250825"` - - `"code_execution_20250825"` - - - `BetaServerToolCaller20260120 object { tool_id, type }` + - `BetaServerToolCaller20260120 object` - `tool_id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `type: "code_execution_20260120"` - - `"code_execution_20260120"` - - `toolset_name: optional string or null` For a toolset member tool_use, the toolset family. - - `BetaServerToolUseBlock object { id, input, name, 2 more }` + maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$ + + - `BetaServerToolUseBlock object` - `id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `input: map[unknown]` - `name: "advisor" or "web_search" or "web_fetch" or 5 more`
from line 441
- `type: "server_tool_use"` - - `"server_tool_use"` + default: server_tool_use - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - - `BetaDirectCaller object { type }` + - `BetaDirectCaller object` Tool invocation directly from the model. - - `BetaServerToolCaller object { tool_id, type }` + - `BetaServerToolCaller object` Tool invocation generated by a server-side tool. - - `BetaServerToolCaller20260120 object { tool_id, type }` - - - `BetaWebSearchToolResultBlock object { content, tool_use_id, type, caller }` + - `BetaServerToolCaller20260120 object` + + - `BetaWebSearchToolResultBlock object` - `content: BetaWebSearchToolResultBlockContent` - - `BetaWebSearchToolResultError object { error_code, type }` + - `BetaWebSearchToolResultError object` - `error_code: BetaWebSearchToolResultErrorCode`
from line 479
- `type: "web_search_tool_result_error"` - - `"web_search_tool_result_error"` + default: web_search_tool_result_error - `array of BetaWebSearchResultBlock`
from line 491
- `type: "web_search_result"` - - `"web_search_result"` + default: web_search_result - `url: string` - `tool_use_id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `type: "web_search_tool_result"` - - `"web_search_tool_result"` + default: web_search_tool_result - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - - `BetaDirectCaller object { type }` + - `BetaDirectCaller object` Tool invocation directly from the model. - - `BetaServerToolCaller object { tool_id, type }` + - `BetaServerToolCaller object` Tool invocation generated by a server-side tool. - - `BetaServerToolCaller20260120 object { tool_id, type }` - - - `BetaWebFetchToolResultBlock object { content, tool_use_id, type, caller }` + - `BetaServerToolCaller20260120 object` + + - `BetaWebFetchToolResultBlock object` - `content: BetaWebFetchToolResultErrorBlock or BetaWebFetchBlock` - - `BetaWebFetchToolResultErrorBlock object { error_code, type }` + - `BetaWebFetchToolResultErrorBlock object` - `error_code: BetaWebFetchToolResultErrorCode`
from line 545
- `type: "web_fetch_tool_result_error"` - - `"web_fetch_tool_result_error"` - - - `BetaWebFetchBlock object { content, retrieved_at, type, url }` + default: web_fetch_tool_result_error + + - `BetaWebFetchBlock object` - `content: BetaDocumentBlock`
from line 557
- `enabled: boolean` + default: false + - `source: BetaBase64PDFSource or BetaPlainTextSource` - - `BetaBase64PDFSource object { data, media_type, type }` + - `BetaBase64PDFSource object` - `data: string` + format: byte + - `media_type: "application/pdf"` - - `"application/pdf"` - - `type: "base64"` - - `"base64"` - - - `BetaPlainTextSource object { data, media_type, type }` + - `BetaPlainTextSource object` - `data: string` - `media_type: "text/plain"` - - `"text/plain"` - - `type: "text"` - - `"text"` - - `title: string or null` The title of the document - `type: "document"` - - `"document"` + default: document - `retrieved_at: string or null`
from line 593
- `type: "web_fetch_result"` - - `"web_fetch_result"` + default: web_fetch_result - `url: string`
from line 601
- `tool_use_id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `type: "web_fetch_tool_result"` - - `"web_fetch_tool_result"` + default: web_fetch_tool_result - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - - `BetaDirectCaller object { type }` + - `BetaDirectCaller object` Tool invocation directly from the model. - - `BetaServerToolCaller object { tool_id, type }` + - `BetaServerToolCaller object` Tool invocation generated by a server-side tool. - - `BetaServerToolCaller20260120 object { tool_id, type }` - - - `BetaAdvisorToolResultBlock object { content, tool_use_id, type }` + - `BetaServerToolCaller20260120 object` + + - `BetaAdvisorToolResultBlock object` - `content: BetaAdvisorToolResultError or BetaAdvisorResultBlock or BetaAdvisorRedactedResultBlock` - - `BetaAdvisorToolResultError object { error_code, type }` + - `BetaAdvisorToolResultError object` - `error_code: "max_uses_exceeded" or "prompt_too_long" or "too_many_requests" or 4 more`
from line 645
- `type: "advisor_tool_result_error"` - - `"advisor_tool_result_error"` - - - `BetaAdvisorResultBlock object { stop_reason, text, type }` + default: advisor_tool_result_error + + - `BetaAdvisorResultBlock object` - `stop_reason: string or null`
from line 657
- `type: "advisor_result"` - - `"advisor_result"` - - - `BetaAdvisorRedactedResultBlock object { encrypted_content, stop_reason, type }` + default: advisor_result + + - `BetaAdvisorRedactedResultBlock object` - `encrypted_content: string`
from line 671
- `type: "advisor_redacted_result"` - - `"advisor_redacted_result"` + default: advisor_redacted_result - `tool_use_id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `type: "advisor_tool_result"` - - `"advisor_tool_result"` - - - `BetaCodeExecutionToolResultBlock object { content, tool_use_id, type }` + default: advisor_tool_result + + - `BetaCodeExecutionToolResultBlock object` - `content: BetaCodeExecutionToolResultBlockContent` Code execution result with encrypted stdout for PFC + web_search results. - - `BetaCodeExecutionToolResultError object { error_code, type }` + - `BetaCodeExecutionToolResultError object` - `error_code: BetaCodeExecutionToolResultErrorCode`
from line 701
- `type: "code_execution_tool_result_error"` - - `"code_execution_tool_result_error"` - - - `BetaCodeExecutionResultBlock object { content, return_code, stderr, 2 more }` + default: code_execution_tool_result_error + + - `BetaCodeExecutionResultBlock object` - `content: array of BetaCodeExecutionOutputBlock`
from line 711
- `type: "code_execution_output"` - - `"code_execution_output"` + default: code_execution_output - `return_code: number`
from line 721
- `type: "code_execution_result"` - - `"code_execution_result"` - - - `BetaEncryptedCodeExecutionResultBlock object { content, encrypted_stdout, return_code, 2 more }` + default: code_execution_result + + - `BetaEncryptedCodeExecutionResultBlock object` Code execution result with encrypted stdout for PFC + web_search results.
from line 733
- `type: "code_execution_output"` + default: code_execution_output + - `encrypted_stdout: string` - `return_code: number`
from line 743
- `type: "encrypted_code_execution_result"` - - `"encrypted_code_execution_result"` + default: encrypted_code_execution_result - `tool_use_id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `type: "code_execution_tool_result"` - - `"code_execution_tool_result"` - - - `BetaBashCodeExecutionToolResultBlock object { content, tool_use_id, type }` + default: code_execution_tool_result + + - `BetaBashCodeExecutionToolResultBlock object` - `content: BetaBashCodeExecutionToolResultError or BetaBashCodeExecutionResultBlock` - - `BetaBashCodeExecutionToolResultError object { error_code, type }` + - `BetaBashCodeExecutionToolResultError object` - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more`
from line 773
- `type: "bash_code_execution_tool_result_error"` - - `"bash_code_execution_tool_result_error"` - - - `BetaBashCodeExecutionResultBlock object { content, return_code, stderr, 2 more }` + default: bash_code_execution_tool_result_error + + - `BetaBashCodeExecutionResultBlock object` - `content: array of BetaBashCodeExecutionOutputBlock`
from line 783
- `type: "bash_code_execution_output"` - - `"bash_code_execution_output"` + default: bash_code_execution_output - `return_code: number`
from line 793
- `type: "bash_code_execution_result"` - - `"bash_code_execution_result"` + default: bash_code_execution_result - `tool_use_id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `type: "bash_code_execution_tool_result"` - - `"bash_code_execution_tool_result"` - - - `BetaTextEditorCodeExecutionToolResultBlock object { content, tool_use_id, type }` + default: bash_code_execution_tool_result + + - `BetaTextEditorCodeExecutionToolResultBlock object` - `content: BetaTextEditorCodeExecutionToolResultError or BetaTextEditorCodeExecutionViewResultBlock or BetaTextEditorCodeExecutionCreateResultBlock or BetaTextEditorCodeExecutionStrReplaceResultBlock` - - `BetaTextEditorCodeExecutionToolResultError object { error_code, error_message, type }` + - `BetaTextEditorCodeExecutionToolResultError object` - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more`
from line 825
- `type: "text_editor_code_execution_tool_result_error"` - - `"text_editor_code_execution_tool_result_error"` - - - `BetaTextEditorCodeExecutionViewResultBlock object { content, file_type, num_lines, 3 more }` + default: text_editor_code_execution_tool_result_error + + - `BetaTextEditorCodeExecutionViewResultBlock object` - `content: string`
from line 847
- `type: "text_editor_code_execution_view_result"` - - `"text_editor_code_execution_view_result"` - - - `BetaTextEditorCodeExecutionCreateResultBlock object { is_file_update, type }` + default: text_editor_code_execution_view_result + + - `BetaTextEditorCodeExecutionCreateResultBlock object` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - - `"text_editor_code_execution_create_result"` - - - `BetaTextEditorCodeExecutionStrReplaceResultBlock object { lines, new_lines, new_start, 3 more }` + default: text_editor_code_execution_create_result + + - `BetaTextEditorCodeExecutionStrReplaceResultBlock object` - `lines: array of string or null`
from line 871
- `type: "text_editor_code_execution_str_replace_result"` - - `"text_editor_code_execution_str_replace_result"` + default: text_editor_code_execution_str_replace_result - `tool_use_id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `type: "text_editor_code_execution_tool_result"` - - `"text_editor_code_execution_tool_result"` - - - `BetaToolSearchToolResultBlock object { content, tool_use_id, type }` + default: text_editor_code_execution_tool_result + + - `BetaToolSearchToolResultBlock object` - `content: BetaToolSearchToolResultError or BetaToolSearchToolSearchResultBlock` - - `BetaToolSearchToolResultError object { error_code, error_message, type }` + - `BetaToolSearchToolResultError object` - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or "execution_time_exceeded"`
from line 901
- `type: "tool_search_tool_result_error"` - - `"tool_search_tool_result_error"` - - - `BetaToolSearchToolSearchResultBlock object { tool_references, type }` + default: tool_search_tool_result_error + + - `BetaToolSearchToolSearchResultBlock object` - `tool_references: array of BetaToolReferenceBlock` - `tool_name: string` + maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$ + - `type: "tool_reference"` - - `"tool_reference"` + default: tool_reference - `type: "tool_search_tool_search_result"` - - `"tool_search_tool_search_result"` + default: tool_search_tool_search_result - `tool_use_id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `type: "tool_search_tool_result"` - - `"tool_search_tool_result"` - - - `BetaMCPToolUseBlock object { id, input, name, 2 more }` + default: tool_search_tool_result + + - `BetaMCPToolUseBlock object` - `id: string` + pattern: ^[a-zA-Z0-9_-]+$ + - `input: map[unknown]` - `name: string`
from line 945
- `type: "mcp_tool_use"` - - `"mcp_tool_use"` - - - `BetaMCPToolResultBlock object { content, is_error, tool_use_id, type }` + default: mcp_tool_use + + - `BetaMCPToolResultBlock object` - `content: string or array of BetaTextBlock`
from line 963
- `text: string` + maxLength: 5000000, minLength: 0 + - `type: "text"` + default: text + - `is_error: boolean` + default: false + - `tool_use_id: string` + pattern: ^[a-zA-Z0-9_-]+$ + - `type: "mcp_tool_result"` - - `"mcp_tool_result"` - - - `BetaContainerUploadBlock object { file_id, type }` + default: mcp_tool_result + + - `BetaContainerUploadBlock object` Response model for a file uploaded to the container.
from line 989
- `type: "container_upload"` - - `"container_upload"` - - - `BetaCompactionBlock object { content, encrypted_content, type }` + default: container_upload + + - `BetaCompactionBlock object` A compaction block returned when autocompact is triggered.
from line 1009
- `type: "compaction"` - - `"compaction"` - - - `BetaFallbackBlock object { from, to, trigger, type }` + default: compaction + + - `BetaFallbackBlock object` Marks the point in `content` where one model's output gives way to the next.
from line 1137
- `type: "refusal"` - - `"refusal"` + default: refusal - `type: "fallback"` - - `"fallback"` + default: fallback - `context_management: BetaContextManagementResponse or null`
from line 1153
List of context management edits that were applied. - - `BetaClearToolUses20250919EditResponse object { cleared_input_tokens, cleared_tool_uses, type }` + - `BetaClearToolUses20250919EditResponse object` - `cleared_input_tokens: number` Number of input tokens cleared by this edit. + minimum: 0 + - `cleared_tool_uses: number` Number of tool uses that were cleared. + minimum: 0 + - `type: "clear_tool_uses_20250919"` The type of context management edit applied. - - `"clear_tool_uses_20250919"` - - - `BetaClearThinking20251015EditResponse object { cleared_input_tokens, cleared_thinking_turns, type }` + default: clear_tool_uses_20250919 + + - `BetaClearThinking20251015EditResponse object` - `cleared_input_tokens: number` Number of input tokens cleared by this edit. + minimum: 0 + - `cleared_thinking_turns: number` Number of thinking turns that were cleared. + minimum: 0 + - `type: "clear_thinking_20251015"` The type of context management edit applied. - - `"clear_thinking_20251015"` + default: clear_thinking_20251015 - `diagnostics: BetaDiagnostics or null`
from line 1202
Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - - `BetaCacheMissModelChanged object { cache_missed_input_tokens, type }` + - `BetaCacheMissModelChanged object` - `cache_missed_input_tokens: number`
from line 1210
- `type: "model_changed"` - - `"model_changed"` - - - `BetaCacheMissSystemChanged object { cache_missed_input_tokens, type }` + default: model_changed + + - `BetaCacheMissSystemChanged object` - `cache_missed_input_tokens: number`
from line 1220
- `type: "system_changed"` - - `"system_changed"` - - - `BetaCacheMissToolsChanged object { cache_missed_input_tokens, type }` + default: system_changed + + - `BetaCacheMissToolsChanged object` - `cache_missed_input_tokens: number`
from line 1230
- `type: "tools_changed"` - - `"tools_changed"` - - - `BetaCacheMissMessagesChanged object { cache_missed_input_tokens, type }` + default: tools_changed + + - `BetaCacheMissMessagesChanged object` - `cache_missed_input_tokens: number`
from line 1240
- `type: "messages_changed"` - - `"messages_changed"` - - - `BetaCacheMissPreviousMessageNotFound object { type }` + default: messages_changed + + - `BetaCacheMissPreviousMessageNotFound object` - `type: "previous_message_not_found"` - - `"previous_message_not_found"` - - - `BetaCacheMissUnavailable object { type }` + default: previous_message_not_found + + - `BetaCacheMissUnavailable object` - `type: "unavailable"` - - `"unavailable"` + default: unavailable - `model: Model`
from line 1266
This will always be `"assistant"`. - - `"assistant"` + default: assistant - `stop_details: BetaRefusalStopDetails or null`
from line 1353
- `type: "refusal"` - - `"refusal"` + default: refusal - `stop_reason: BetaStopReason or null`
from line 1399
For Messages, this is always `"message"`. - - `"message"` + default: message - `usage: BetaUsage`
from line 1421
The number of input tokens used to create the 1 hour cache entry. + default: 0, minimum: 0 + - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. + default: 0, minimum: 0 + - `cache_creation_input_tokens: number or null` The number of input tokens used to create the cache entry. + minimum: 0 + - `cache_read_input_tokens: number or null` The number of input tokens read from the cache. + + minimum: 0 - `fallback_credit: BetaFallbackCreditUsage or null`
from line 1454
resulting shift is zero because there was nothing to move. `not_applied`: no reprice was applied; the arm's `reason` says why. - - `BetaFallbackCreditRedeemed object { type }` + - `BetaFallbackCreditRedeemed object` The reprice was applied: the retry is billed as if the conversation had been on the retry model all along. - `type: "redeemed"` - - `"redeemed"` - - - `BetaFallbackCreditNotApplied object { reason, type, remove_to_redeem }` + default: redeemed + + - `BetaFallbackCreditNotApplied object` No reprice was applied; `reason` says why.
from line 1500
- `type: "not_applied"` - - `"not_applied"` + default: not_applied - `remove_to_redeem: optional array of string or null`
from line 1521
The number of input tokens which were used. + minimum: 0 + - `iterations: BetaIterationsUsage or null` Per-iteration token usage breakdown.
from line 1533
- Calculate the true context window size from the last iteration - Understand token accumulation across server-side tool use loops - - `BetaMessageIterationUsage object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 more }` + - `BetaMessageIterationUsage object` Token usage for a sampling iteration.
from line 1545
The number of input tokens used to create the cache entry. + default: 0, minimum: 0 + - `cache_read_input_tokens: number` The number of input tokens read from the cache. + default: 0, minimum: 0 + - `input_tokens: number` The number of input tokens which were used. + minimum: 0 + - `model: Model` The model that will complete your prompt.
from line 1569
The number of output tokens which were used. + minimum: 0 + - `type: "message"` Usage for a sampling iteration - - `"message"` - - - `BetaCompactionIterationUsage object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` + default: message + + - `BetaCompactionIterationUsage object` Token usage for a compaction iteration.
from line 1589
The number of input tokens used to create the cache entry. + default: 0, minimum: 0 + - `cache_read_input_tokens: number` The number of input tokens read from the cache. + default: 0, minimum: 0 + - `input_tokens: number` The number of input tokens which were used. + minimum: 0 + - `output_tokens: number` The number of output tokens which were used. + minimum: 0 + - `type: "compaction"` Usage for a compaction iteration - - `"compaction"` - - - `BetaAdvisorMessageIterationUsage object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 more }` + default: compaction + + - `BetaAdvisorMessageIterationUsage object` Token usage for an advisor sub-inference iteration.
from line 1627
The number of input tokens used to create the cache entry. + default: 0, minimum: 0 + - `cache_read_input_tokens: number` The number of input tokens read from the cache. + default: 0, minimum: 0 + - `input_tokens: number` The number of input tokens which were used. + minimum: 0 + - `model: Model` The model that will complete your prompt.
from line 1651
The number of output tokens which were used. + minimum: 0 + - `type: "advisor_message"` Usage for an advisor sub-inference iteration - - `"advisor_message"` - - - `BetaFallbackMessageIterationUsage object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 more }` + default: advisor_message + + - `BetaFallbackMessageIterationUsage object` Token usage for the fallback-model attempt of a server-side fallback request.
from line 1676
The number of input tokens used to create the cache entry. + default: 0, minimum: 0 + - `cache_read_input_tokens: number` The number of input tokens read from the cache. + default: 0, minimum: 0 + - `input_tokens: number` The number of input tokens which were used. + minimum: 0 + - `model: Model` The model that will complete your prompt.
from line 1700
The number of output tokens which were used. + minimum: 0 + - `type: "fallback_message"` Usage for the fallback-model attempt that served the response - - `"fallback_message"` + default: fallback_message - `output_tokens: number` The number of output tokens which were used. + + minimum: 0 - `output_tokens_details: BetaOutputTokensDetails or null`
from line 1734
generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. + default: 0, minimum: 0 + - `server_tool_use: BetaServerToolUsage or null` The number of server tool requests.
from line 1744
The number of web fetch tool requests. + default: 0, minimum: 0 + - `web_search_requests: number` The number of web search tool requests. + default: 0, minimum: 0 + - `service_tier: "standard" or "priority" or "batch" or null` If the request used the priority, standard, or batch tier.
from line 1772
- `type: "succeeded"` - - `"succeeded"` - - - `BetaMessageBatchErroredResult object { error, type }` + default: succeeded + + - `BetaMessageBatchErroredResult object` - `error: BetaErrorResponse` - `error: BetaError` - - `BetaInvalidRequestError object { message, type }` + - `BetaInvalidRequestError object` - `message: string` + default: Invalid request + - `type: "invalid_request_error"` - - `"invalid_request_error"` - - - `BetaAuthenticationError object { message, type }` + default: invalid_request_error + + - `BetaAuthenticationError object` - `message: string` + default: Authentication error + - `type: "authentication_error"` - - `"authentication_error"` - - - `BetaBillingError object { message, type }` + default: authentication_error + + - `BetaBillingError object` - `message: string` + default: Billing error + - `type: "billing_error"` - - `"billing_error"` - - - `BetaPermissionError object { message, type }` + default: billing_error + + - `BetaPermissionError object` - `message: string` + default: Permission denied + - `type: "permission_error"` - - `"permission_error"` - - - `BetaNotFoundError object { message, type }` + default: permission_error + + - `BetaNotFoundError object` - `message: string` + default: Not found + - `type: "not_found_error"` - - `"not_found_error"` - - - `BetaRateLimitError object { message, type }` + default: not_found_error + + - `BetaRateLimitError object` - `message: string` + default: Rate limited + - `type: "rate_limit_error"` - - `"rate_limit_error"` - - - `BetaGatewayTimeoutError object { message, type }` + default: rate_limit_error + + - `BetaGatewayTimeoutError object` - `message: string` + default: Request timeout + - `type: "timeout_error"` - - `"timeout_error"` - - - `BetaAPIError object { message, type }` + default: timeout_error + + - `BetaAPIError object` - `message: string` + default: Internal server error + - `type: "api_error"` - - `"api_error"` - - - `BetaOverloadedError object { message, type }` + default: api_error + + - `BetaOverloadedError object` - `message: string` + default: Overloaded + - `type: "overloaded_error"` - - `"overloaded_error"` + default: overloaded_error - `request_id: string or null` - `type: "error"` - - `"error"` + default: error - `type: "errored"` - - `"errored"` - - - `BetaMessageBatchCanceledResult object { type }` + default: errored + + - `BetaMessageBatchCanceledResult object` - `type: "canceled"` - - `"canceled"` - - - `BetaMessageBatchExpiredResult object { type }` + default: canceled + + - `BetaMessageBatchExpiredResult object` - `type: "expired"` - - `"expired"` - -### Example - -```http + default: expired + +## Example + +```bash curl https://api.anthropic.com/v1/messages/batches/$MESSAGE_BATCH_ID/results \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: message-batches-2024-09-24' \