中文 ← MyDocs

Retrieve Message Batch results

get /v1/messages/batches/{message_batch_id}/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

Path Parameters

  • message_batch_id: string

    ID of the Message Batch.

Header Parameters

  • "anthropic-beta": optional array of AnthropicBeta

    Optional header to specify the beta version(s) you want to use.

    • string

    • "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 22 more

      • "message-batches-2024-09-24"

      • "prompt-caching-2024-07-31"

      • "computer-use-2024-10-22"

      • "computer-use-2025-01-24"

      • "pdfs-2024-09-25"

      • "token-counting-2024-11-01"

      • "token-efficient-tools-2025-02-19"

      • "output-128k-2025-02-19"

      • "files-api-2025-04-14"

      • "mcp-client-2025-04-04"

      • "mcp-client-2025-11-20"

      • "dev-full-thinking-2025-05-14"

      • "interleaved-thinking-2025-05-14"

      • "code-execution-2025-05-22"

      • "extended-cache-ttl-2025-04-11"

      • "context-1m-2025-08-07"

      • "context-management-2025-06-27"

      • "model-context-window-exceeded-2025-08-26"

      • "skills-2025-10-02"

      • "fast-mode-2026-02-01"

      • "output-300k-2026-03-24"

      • "user-profiles-2026-03-24"

      • "advisor-tool-2026-03-01"

      • "managed-agents-2026-04-01"

      • "cache-diagnosis-2026-04-07"

Returns

  • BetaMessageBatchIndividualResponse object { custom_id, result }

    This is a single line in the response .jsonl file and does not represent the response as a whole.

    • custom_id: string

      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: BetaMessageBatchResult

      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 object { message, type }

        • message: BetaMessage

          • id: string

            Unique object identifier.

            The format and length of IDs may change over time.

          • container: BetaContainer

            Information about the container used in the request (for the code execution tool)

            • id: string

              Identifier for the container used in this request

            • expires_at: string

              The time at which the container will expire.

            • skills: array of BetaSkill

              Skills loaded in the container

              • skill_id: string

                Skill ID

              • type: "anthropic" or "custom"

                Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)

                • "anthropic"

                • "custom"

              • version: string

                Skill version or 'latest' for most recent version

          • content: array of BetaContentBlock

            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 object { citations, text, type }

              • citations: array of BetaTextCitation

                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 object { cited_text, document_index, document_title, 4 more }

                  • cited_text: string

                  • document_index: number

                  • document_title: string

                  • end_char_index: number

                  • file_id: string

                  • start_char_index: number

                  • type: "char_location"

                    • "char_location"

                • BetaCitationPageLocation object { cited_text, document_index, document_title, 4 more }

                  • cited_text: string

                  • document_index: number

                  • document_title: string

                  • end_page_number: number

                  • file_id: string

                  • start_page_number: number

                  • type: "page_location"

                    • "page_location"

                • BetaCitationContentBlockLocation object { cited_text, document_index, document_title, 4 more }

                  • cited_text: string

                    The full text of the cited block range, concatenated.

                    Always equals the contents of content[start_block_index:end_block_index] joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns.

                  • document_index: number

                  • document_title: string

                  • end_block_index: number

                    Exclusive 0-based end index of the cited block range in the source's content array.

                    Always greater than start_block_index; a single-block citation has end_block_index = start_block_index + 1.

                  • file_id: string

                  • start_block_index: number

                    0-based index of the first cited block in the source's content array.

                  • type: "content_block_location"

                    • "content_block_location"

                • BetaCitationsWebSearchResultLocation object { cited_text, encrypted_index, title, 2 more }

                  • cited_text: string

                  • encrypted_index: string

                  • title: string

                  • type: "web_search_result_location"

                    • "web_search_result_location"

                  • url: string

                • BetaCitationSearchResultLocation object { cited_text, end_block_index, search_result_index, 4 more }

                  • cited_text: string

                    The full text of the cited block range, concatenated.

                    Always equals the contents of content[start_block_index:end_block_index] joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns.

                  • end_block_index: number

                    Exclusive 0-based end index of the cited block range in the source's content array.

                    Always greater than start_block_index; a single-block citation has end_block_index = start_block_index + 1.

                  • search_result_index: number

                    0-based index of the cited search result among all search_result content blocks in the request, in the order they appear across messages and tool results.

                    Counted separately from document_index; server-side web search results are not included in this count.

                  • source: string

                  • start_block_index: number

                    0-based index of the first cited block in the source's content array.

                  • title: string

                  • type: "search_result_location"

                    • "search_result_location"

              • text: string

              • type: "text"

                • "text"

            • BetaThinkingBlock object { signature, thinking, type }

              • signature: string

              • thinking: string

              • type: "thinking"

                • "thinking"

            • BetaRedactedThinkingBlock object { data, type }

              • data: string

              • type: "redacted_thinking"

                • "redacted_thinking"

            • BetaToolUseBlock object { id, input, name, 2 more }

              • id: string

              • input: map[unknown]

              • name: string

              • type: "tool_use"

                • "tool_use"

              • caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120

                Tool invocation directly from the model.

                • BetaDirectCaller object { type }

                  Tool invocation directly from the model.

                  • type: "direct"

                    • "direct"

                • BetaServerToolCaller object { tool_id, type }

                  Tool invocation generated by a server-side tool.

                  • tool_id: string

                  • type: "code_execution_20250825"

                    • "code_execution_20250825"

                • BetaServerToolCaller20260120 object { tool_id, type }

                  • tool_id: string

                  • type: "code_execution_20260120"

                    • "code_execution_20260120"

            • BetaServerToolUseBlock object { id, input, name, 2 more }

              • id: string

              • input: map[unknown]

              • name: "advisor" or "web_search" or "web_fetch" or 5 more

                • "advisor"

                • "web_search"

                • "web_fetch"

                • "code_execution"

                • "bash_code_execution"

                • "text_editor_code_execution"

                • "tool_search_tool_regex"

                • "tool_search_tool_bm25"

              • type: "server_tool_use"

                • "server_tool_use"

              • caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120

                Tool invocation directly from the model.

                • BetaDirectCaller object { type }

                  Tool invocation directly from the model.

                • BetaServerToolCaller object { tool_id, type }

                  Tool invocation generated by a server-side tool.

                • BetaServerToolCaller20260120 object { tool_id, type }

            • BetaWebSearchToolResultBlock object { content, tool_use_id, type, caller }

              • content: BetaWebSearchToolResultBlockContent

                • BetaWebSearchToolResultError object { error_code, type }

                  • error_code: BetaWebSearchToolResultErrorCode

                    • "invalid_tool_input"

                    • "unavailable"

                    • "max_uses_exceeded"

                    • "too_many_requests"

                    • "query_too_long"

                    • "request_too_large"

                  • type: "web_search_tool_result_error"

                    • "web_search_tool_result_error"

                • array of BetaWebSearchResultBlock

                  • encrypted_content: string

                  • page_age: string

                  • title: string

                  • type: "web_search_result"

                    • "web_search_result"

                  • url: string

              • tool_use_id: string

              • type: "web_search_tool_result"

                • "web_search_tool_result"

              • caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120

                Tool invocation directly from the model.

                • BetaDirectCaller object { type }

                  Tool invocation directly from the model.

                • BetaServerToolCaller object { tool_id, type }

                  Tool invocation generated by a server-side tool.

                • BetaServerToolCaller20260120 object { tool_id, type }

            • BetaWebFetchToolResultBlock object { content, tool_use_id, type, caller }

              • content: BetaWebFetchToolResultErrorBlock or BetaWebFetchBlock

                • BetaWebFetchToolResultErrorBlock object { error_code, type }

                  • error_code: BetaWebFetchToolResultErrorCode

                    • "invalid_tool_input"

                    • "url_too_long"

                    • "url_not_allowed"

                    • "url_not_accessible"

                    • "unsupported_content_type"

                    • "too_many_requests"

                    • "max_uses_exceeded"

                    • "unavailable"

                  • type: "web_fetch_tool_result_error"

                    • "web_fetch_tool_result_error"

                • BetaWebFetchBlock object { content, retrieved_at, type, url }

                  • content: BetaDocumentBlock

                    • citations: BetaCitationConfig

                      Citation configuration for the document

                      • enabled: boolean

                    • source: BetaBase64PDFSource or BetaPlainTextSource

                      • BetaBase64PDFSource object { data, media_type, type }

                        • data: string

                        • media_type: "application/pdf"

                          • "application/pdf"

                        • type: "base64"

                          • "base64"

                      • BetaPlainTextSource object { data, media_type, type }

                        • data: string

                        • media_type: "text/plain"

                          • "text/plain"

                        • type: "text"

                          • "text"

                    • title: string

                      The title of the document

                    • type: "document"

                      • "document"

                  • retrieved_at: string

                    ISO 8601 timestamp when the content was retrieved

                  • type: "web_fetch_result"

                    • "web_fetch_result"

                  • url: string

                    Fetched content URL

              • tool_use_id: string

              • type: "web_fetch_tool_result"

                • "web_fetch_tool_result"

              • caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120

                Tool invocation directly from the model.

                • BetaDirectCaller object { type }

                  Tool invocation directly from the model.

                • BetaServerToolCaller object { tool_id, type }

                  Tool invocation generated by a server-side tool.

                • BetaServerToolCaller20260120 object { tool_id, type }

            • BetaAdvisorToolResultBlock object { content, tool_use_id, type }

              • content: BetaAdvisorToolResultError or BetaAdvisorResultBlock or BetaAdvisorRedactedResultBlock

                • BetaAdvisorToolResultError object { error_code, type }

                  • error_code: "max_uses_exceeded" or "prompt_too_long" or "too_many_requests" or 3 more

                    • "max_uses_exceeded"

                    • "prompt_too_long"

                    • "too_many_requests"

                    • "overloaded"

                    • "unavailable"

                    • "execution_time_exceeded"

                  • type: "advisor_tool_result_error"

                    • "advisor_tool_result_error"

                • BetaAdvisorResultBlock object { text, type }

                  • text: string

                  • type: "advisor_result"

                    • "advisor_result"

                • BetaAdvisorRedactedResultBlock object { encrypted_content, type }

                  • encrypted_content: string

                    Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify.

                  • type: "advisor_redacted_result"

                    • "advisor_redacted_result"

              • tool_use_id: string

              • type: "advisor_tool_result"

                • "advisor_tool_result"

            • BetaCodeExecutionToolResultBlock object { content, tool_use_id, type }

              • content: BetaCodeExecutionToolResultBlockContent

                Code execution result with encrypted stdout for PFC + web_search results.

                • BetaCodeExecutionToolResultError object { error_code, type }

                  • error_code: BetaCodeExecutionToolResultErrorCode

                    • "invalid_tool_input"

                    • "unavailable"

                    • "too_many_requests"

                    • "execution_time_exceeded"

                  • type: "code_execution_tool_result_error"

                    • "code_execution_tool_result_error"

                • BetaCodeExecutionResultBlock object { content, return_code, stderr, 2 more }

                  • content: array of BetaCodeExecutionOutputBlock

                    • file_id: string

                    • type: "code_execution_output"

                      • "code_execution_output"

                  • return_code: number

                  • stderr: string

                  • stdout: string

                  • type: "code_execution_result"

                    • "code_execution_result"

                • BetaEncryptedCodeExecutionResultBlock object { content, encrypted_stdout, return_code, 2 more }

                  Code execution result with encrypted stdout for PFC + web_search results.

                  • content: array of BetaCodeExecutionOutputBlock

                    • file_id: string

                    • type: "code_execution_output"

                  • encrypted_stdout: string

                  • return_code: number

                  • stderr: string

                  • type: "encrypted_code_execution_result"

                    • "encrypted_code_execution_result"

              • tool_use_id: string

              • type: "code_execution_tool_result"

                • "code_execution_tool_result"

            • BetaBashCodeExecutionToolResultBlock object { content, tool_use_id, type }

              • content: BetaBashCodeExecutionToolResultError or BetaBashCodeExecutionResultBlock

                • BetaBashCodeExecutionToolResultError object { error_code, type }

                  • error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more

                    • "invalid_tool_input"

                    • "unavailable"

                    • "too_many_requests"

                    • "execution_time_exceeded"

                    • "output_file_too_large"

                  • type: "bash_code_execution_tool_result_error"

                    • "bash_code_execution_tool_result_error"

                • BetaBashCodeExecutionResultBlock object { content, return_code, stderr, 2 more }

                  • content: array of BetaBashCodeExecutionOutputBlock

                    • file_id: string

                    • type: "bash_code_execution_output"

                      • "bash_code_execution_output"

                  • return_code: number

                  • stderr: string

                  • stdout: string

                  • type: "bash_code_execution_result"

                    • "bash_code_execution_result"

              • tool_use_id: string

              • type: "bash_code_execution_tool_result"

                • "bash_code_execution_tool_result"

            • BetaTextEditorCodeExecutionToolResultBlock object { content, tool_use_id, type }

              • content: BetaTextEditorCodeExecutionToolResultError or BetaTextEditorCodeExecutionViewResultBlock or BetaTextEditorCodeExecutionCreateResultBlock or BetaTextEditorCodeExecutionStrReplaceResultBlock

                • BetaTextEditorCodeExecutionToolResultError object { error_code, error_message, type }

                  • error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more

                    • "invalid_tool_input"

                    • "unavailable"

                    • "too_many_requests"

                    • "execution_time_exceeded"

                    • "file_not_found"

                  • error_message: string

                  • type: "text_editor_code_execution_tool_result_error"

                    • "text_editor_code_execution_tool_result_error"

                • BetaTextEditorCodeExecutionViewResultBlock object { content, file_type, num_lines, 3 more }

                  • content: string

                  • file_type: "text" or "image" or "pdf"

                    • "text"

                    • "image"

                    • "pdf"

                  • num_lines: number

                  • start_line: number

                  • total_lines: number

                  • type: "text_editor_code_execution_view_result"

                    • "text_editor_code_execution_view_result"

                • BetaTextEditorCodeExecutionCreateResultBlock object { is_file_update, type }

                  • 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 }

                  • lines: array of string

                  • new_lines: number

                  • new_start: number

                  • old_lines: number

                  • old_start: number

                  • type: "text_editor_code_execution_str_replace_result"

                    • "text_editor_code_execution_str_replace_result"

              • tool_use_id: string

              • type: "text_editor_code_execution_tool_result"

                • "text_editor_code_execution_tool_result"

            • BetaToolSearchToolResultBlock object { content, tool_use_id, type }

              • content: BetaToolSearchToolResultError or BetaToolSearchToolSearchResultBlock

                • BetaToolSearchToolResultError object { error_code, error_message, type }

                  • error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or "execution_time_exceeded"

                    • "invalid_tool_input"

                    • "unavailable"

                    • "too_many_requests"

                    • "execution_time_exceeded"

                  • error_message: string

                  • type: "tool_search_tool_result_error"

                    • "tool_search_tool_result_error"

                • BetaToolSearchToolSearchResultBlock object { tool_references, type }

                  • tool_references: array of BetaToolReferenceBlock

                    • tool_name: string

                    • type: "tool_reference"

                      • "tool_reference"

                  • type: "tool_search_tool_search_result"

                    • "tool_search_tool_search_result"

              • tool_use_id: string

              • type: "tool_search_tool_result"

                • "tool_search_tool_result"

            • BetaMCPToolUseBlock object { id, input, name, 2 more }

              • id: string

              • input: map[unknown]

              • name: string

                The name of the MCP tool

              • server_name: string

                The name of the MCP server

              • type: "mcp_tool_use"

                • "mcp_tool_use"

            • BetaMCPToolResultBlock object { content, is_error, tool_use_id, type }

              • content: string or array of BetaTextBlock

                • string

                • BetaMCPToolResultBlockContent = array of BetaTextBlock

                  • citations: array of BetaTextCitation

                    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.

                  • text: string

                  • type: "text"

              • is_error: boolean

              • tool_use_id: string

              • type: "mcp_tool_result"

                • "mcp_tool_result"

            • BetaContainerUploadBlock object { file_id, type }

              Response model for a file uploaded to the container.

              • file_id: string

              • type: "container_upload"

                • "container_upload"

            • BetaCompactionBlock object { content, encrypted_content, type }

              A compaction block returned when autocompact is triggered.

              When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops.

              • content: string

                Summary of compacted content, or null if compaction failed

              • encrypted_content: string

                Opaque metadata from prior compaction, to be round-tripped verbatim

              • type: "compaction"

                • "compaction"

          • context_management: BetaContextManagementResponse

            Context management response.

            Information about context management strategies applied during the request.

            • applied_edits: array of BetaClearToolUses20250919EditResponse or BetaClearThinking20251015EditResponse

              List of context management edits that were applied.

              • BetaClearToolUses20250919EditResponse object { cleared_input_tokens, cleared_tool_uses, type }

                • cleared_input_tokens: number

                  Number of input tokens cleared by this edit.

                • cleared_tool_uses: number

                  Number of tool uses that were cleared.

                • 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 }

                • cleared_input_tokens: number

                  Number of input tokens cleared by this edit.

                • cleared_thinking_turns: number

                  Number of thinking turns that were cleared.

                • type: "clear_thinking_20251015"

                  The type of context management edit applied.

                  • "clear_thinking_20251015"

          • diagnostics: BetaDiagnostics

            Response envelope for request-level diagnostics. Present (possibly null) whenever the caller supplied diagnostics on the request.

            • cache_miss_reason: BetaCacheMissModelChanged or BetaCacheMissSystemChanged or BetaCacheMissToolsChanged or 3 more

              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 }

                • cache_missed_input_tokens: number

                  Approximate number of input tokens that would have been read from cache had the prefix matched the previous request.

                • type: "model_changed"

                  • "model_changed"

              • BetaCacheMissSystemChanged object { cache_missed_input_tokens, type }

                • cache_missed_input_tokens: number

                  Approximate number of input tokens that would have been read from cache had the prefix matched the previous request.

                • type: "system_changed"

                  • "system_changed"

              • BetaCacheMissToolsChanged object { cache_missed_input_tokens, type }

                • cache_missed_input_tokens: number

                  Approximate number of input tokens that would have been read from cache had the prefix matched the previous request.

                • type: "tools_changed"

                  • "tools_changed"

              • BetaCacheMissMessagesChanged object { cache_missed_input_tokens, type }

                • cache_missed_input_tokens: number

                  Approximate number of input tokens that would have been read from cache had the prefix matched the previous request.

                • type: "messages_changed"

                  • "messages_changed"

              • BetaCacheMissPreviousMessageNotFound object { type }

                • type: "previous_message_not_found"

                  • "previous_message_not_found"

              • BetaCacheMissUnavailable object { type }

                • type: "unavailable"

                  • "unavailable"

          • model: Model

            The model that will complete your prompt.

            See models for additional details and options.

            • "claude-opus-4-7" or "claude-mythos-preview" or "claude-opus-4-6" or 14 more

              The model that will complete your prompt.

              See models for additional details and options.

              • "claude-opus-4-7"

                Frontier intelligence for long-running agents and coding

              • "claude-mythos-preview"

                New class of intelligence, strongest in coding and cybersecurity

              • "claude-opus-4-6"

                Frontier intelligence for long-running agents and coding

              • "claude-sonnet-4-6"

                Best combination of speed and intelligence

              • "claude-haiku-4-5"

                Fastest model with near-frontier intelligence

              • "claude-haiku-4-5-20251001"

                Fastest model with near-frontier intelligence

              • "claude-opus-4-5"

                Premium model combining maximum intelligence with practical performance

              • "claude-opus-4-5-20251101"

                Premium model combining maximum intelligence with practical performance

              • "claude-sonnet-4-5"

                High-performance model for agents and coding

              • "claude-sonnet-4-5-20250929"

                High-performance model for agents and coding

              • "claude-opus-4-1"

                Exceptional model for specialized complex tasks

              • "claude-opus-4-1-20250805"

                Exceptional model for specialized complex tasks

              • "claude-opus-4-0"

                Powerful model for complex tasks

              • "claude-opus-4-20250514"

                Powerful model for complex tasks

              • "claude-sonnet-4-0"

                High-performance model with extended thinking

              • "claude-sonnet-4-20250514"

                High-performance model with extended thinking

              • "claude-3-haiku-20240307"

                Fast and cost-effective model

            • string

          • role: "assistant"

            Conversational role of the generated message.

            This will always be "assistant".

            • "assistant"

          • stop_details: BetaRefusalStopDetails

            Structured information about a refusal.

            • category: "cyber" or "bio"

              The policy category that triggered the refusal.

              null when the refusal doesn't map to a named category.

              • "cyber"

              • "bio"

            • explanation: string

              Human-readable explanation of the refusal.

              This text is not guaranteed to be stable. null when no explanation is available for the category.

            • type: "refusal"

              • "refusal"

          • stop_reason: BetaStopReason

            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.

            • "end_turn"

            • "max_tokens"

            • "stop_sequence"

            • "tool_use"

            • "pause_turn"

            • "compaction"

            • "refusal"

            • "model_context_window_exceeded"

          • stop_sequence: string

            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".

            • "message"

          • usage: BetaUsage

            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.

            • cache_creation: BetaCacheCreation

              Breakdown of cached tokens by TTL

              • ephemeral_1h_input_tokens: number

                The number of input tokens used to create the 1 hour cache entry.

              • ephemeral_5m_input_tokens: number

                The number of input tokens used to create the 5 minute cache entry.

            • cache_creation_input_tokens: number

              The number of input tokens used to create the cache entry.

            • cache_read_input_tokens: number

              The number of input tokens read from the cache.

            • inference_geo: string

              The geographic region where inference was performed for this request.

            • input_tokens: number

              The number of input tokens which were used.

            • iterations: BetaIterationsUsage

              Per-iteration token usage breakdown.

              Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to:

              • Determine which iterations exceeded long context thresholds (>=200k tokens)

              • 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, 3 more }

                Token usage for a sampling iteration.

                • cache_creation: BetaCacheCreation

                  Breakdown of cached tokens by TTL

                • cache_creation_input_tokens: number

                  The number of input tokens used to create the cache entry.

                • cache_read_input_tokens: number

                  The number of input tokens read from the cache.

                • input_tokens: number

                  The number of input tokens which were used.

                • output_tokens: number

                  The number of output tokens which were used.

                • type: "message"

                  Usage for a sampling iteration

                  • "message"

              • BetaCompactionIterationUsage object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }

                Token usage for a compaction iteration.

                • cache_creation: BetaCacheCreation

                  Breakdown of cached tokens by TTL

                • cache_creation_input_tokens: number

                  The number of input tokens used to create the cache entry.

                • cache_read_input_tokens: number

                  The number of input tokens read from the cache.

                • input_tokens: number

                  The number of input tokens which were used.

                • output_tokens: number

                  The number of output tokens which were used.

                • type: "compaction"

                  Usage for a compaction iteration

                  • "compaction"

              • BetaAdvisorMessageIterationUsage object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 more }

                Token usage for an advisor sub-inference iteration.

                • cache_creation: BetaCacheCreation

                  Breakdown of cached tokens by TTL

                • cache_creation_input_tokens: number

                  The number of input tokens used to create the cache entry.

                • cache_read_input_tokens: number

                  The number of input tokens read from the cache.

                • input_tokens: number

                  The number of input tokens which were used.

                • model: Model

                  The model that will complete your prompt.

                  See models for additional details and options.

                • output_tokens: number

                  The number of output tokens which were used.

                • type: "advisor_message"

                  Usage for an advisor sub-inference iteration

                  • "advisor_message"

            • output_tokens: number

              The number of output tokens which were used.

            • server_tool_use: BetaServerToolUsage

              The number of server tool requests.

              • web_fetch_requests: number

                The number of web fetch tool requests.

              • web_search_requests: number

                The number of web search tool requests.

            • service_tier: "standard" or "priority" or "batch"

              If the request used the priority, standard, or batch tier.

              • "standard"

              • "priority"

              • "batch"

            • speed: "standard" or "fast"

              The inference speed mode used for this request.

              • "standard"

              • "fast"

        • type: "succeeded"

          • "succeeded"

      • BetaMessageBatchErroredResult object { error, type }

        • error: BetaErrorResponse

          • error: BetaError

            • BetaInvalidRequestError object { message, type }

              • message: string

              • type: "invalid_request_error"

                • "invalid_request_error"

            • BetaAuthenticationError object { message, type }

              • message: string

              • type: "authentication_error"

                • "authentication_error"

            • BetaBillingError object { message, type }

              • message: string

              • type: "billing_error"

                • "billing_error"

            • BetaPermissionError object { message, type }

              • message: string

              • type: "permission_error"

                • "permission_error"

            • BetaNotFoundError object { message, type }

              • message: string

              • type: "not_found_error"

                • "not_found_error"

            • BetaRateLimitError object { message, type }

              • message: string

              • type: "rate_limit_error"

                • "rate_limit_error"

            • BetaGatewayTimeoutError object { message, type }

              • message: string

              • type: "timeout_error"

                • "timeout_error"

            • BetaAPIError object { message, type }

              • message: string

              • type: "api_error"

                • "api_error"

            • BetaOverloadedError object { message, type }

              • message: string

              • type: "overloaded_error"

                • "overloaded_error"

          • request_id: string

          • type: "error"

            • "error"

        • type: "errored"

          • "errored"

      • BetaMessageBatchCanceledResult object { type }

        • type: "canceled"

          • "canceled"

      • BetaMessageBatchExpiredResult object { type }

        • type: "expired"

          • "expired"

Example

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' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"