## Retrieve Message Batch results `beta.messages.batches.results(message_batch_id, **kwargs) -> BetaMessageBatchIndividualResponse` **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](https://docs.claude.com/en/docs/build-with-claude/batch-processing) ### Parameters - `message_batch_id: String` ID of the Message Batch. - `betas: Array[AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `String = String` - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 25 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"` - `:"thinking-token-count-2026-05-13"` - `:"server-side-fallback-2026-06-01"` - `:"fallback-credit-2026-06-01"` ### Returns - `class BetaMessageBatchIndividualResponse` 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. - `class BetaMessageBatchSucceededResult` - `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: Time` The time at which the container will expire. - `skills: Array[BetaSkill]` Skills loaded in the container - `skill_id: String` Skill ID - `type: :anthropic | :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[BetaContentBlock]` Content generated by the model. This is an array of content blocks, each of which has a `type` that determines its shape. Example: ```json [{"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: ```json [ {"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: ```json [{"type": "text", "text": "B)"}] ``` - `class BetaTextBlock` - `citations: Array[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`. - `class BetaCitationCharLocation` - `cited_text: String` - `document_index: Integer` - `document_title: String` - `end_char_index: Integer` - `file_id: String` - `start_char_index: Integer` - `type: :char_location` - `:char_location` - `class BetaCitationPageLocation` - `cited_text: String` - `document_index: Integer` - `document_title: String` - `end_page_number: Integer` - `file_id: String` - `start_page_number: Integer` - `type: :page_location` - `:page_location` - `class BetaCitationContentBlockLocation` - `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: Integer` - `document_title: String` - `end_block_index: Integer` 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: Integer` 0-based index of the first cited block in the source's `content` array. - `type: :content_block_location` - `:content_block_location` - `class BetaCitationsWebSearchResultLocation` - `cited_text: String` - `encrypted_index: String` - `title: String` - `type: :web_search_result_location` - `:web_search_result_location` - `url: String` - `class BetaCitationSearchResultLocation` - `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: Integer` 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: Integer` 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: Integer` 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` - `class BetaThinkingBlock` - `signature: String` - `thinking: String` - `type: :thinking` - `:thinking` - `class BetaRedactedThinkingBlock` - `data: String` - `type: :redacted_thinking` - `:redacted_thinking` - `class BetaToolUseBlock` - `id: String` - `input: Hash[Symbol, untyped]` - `name: String` - `type: :tool_use` - `:tool_use` - `caller_: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `class BetaDirectCaller` Tool invocation directly from the model. - `type: :direct` - `:direct` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `tool_id: String` - `type: :code_execution_20250825` - `:code_execution_20250825` - `class BetaServerToolCaller20260120` - `tool_id: String` - `type: :code_execution_20260120` - `:code_execution_20260120` - `class BetaServerToolUseBlock` - `id: String` - `input: Hash[Symbol, untyped]` - `name: :advisor | :web_search | :web_fetch | 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_: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebSearchToolResultBlock` - `content: BetaWebSearchToolResultBlockContent` - `class BetaWebSearchToolResultError` - `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` - `UnionMember1 = Array[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_: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebFetchToolResultBlock` - `content: BetaWebFetchToolResultErrorBlock | BetaWebFetchBlock` - `class BetaWebFetchToolResultErrorBlock` - `error_code: BetaWebFetchToolResultErrorCode` - `:invalid_tool_input` - `:url_too_long` - `:url_not_allowed` - `:url_not_in_prior_context` - `:url_not_accessible` - `:unsupported_content_type` - `:too_many_requests` - `:max_uses_exceeded` - `:unavailable` - `type: :web_fetch_tool_result_error` - `:web_fetch_tool_result_error` - `class BetaWebFetchBlock` - `content: BetaDocumentBlock` - `citations: BetaCitationConfig` Citation configuration for the document - `enabled: bool` - `source: BetaBase64PDFSource | BetaPlainTextSource` - `class BetaBase64PDFSource` - `data: String` - `media_type: :"application/pdf"` - `:"application/pdf"` - `type: :base64` - `:base64` - `class BetaPlainTextSource` - `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_: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaAdvisorToolResultBlock` - `content: BetaAdvisorToolResultError | BetaAdvisorResultBlock | BetaAdvisorRedactedResultBlock` - `class BetaAdvisorToolResultError` - `error_code: :max_uses_exceeded | :prompt_too_long | :too_many_requests | 4 more` - `:max_uses_exceeded` - `:prompt_too_long` - `:too_many_requests` - `:overloaded` - `:unavailable` - `:execution_time_exceeded` - `:model_not_found` - `type: :advisor_tool_result_error` - `:advisor_tool_result_error` - `class BetaAdvisorResultBlock` - `stop_reason: String` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `text: String` - `type: :advisor_result` - `:advisor_result` - `class BetaAdvisorRedactedResultBlock` - `encrypted_content: String` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `stop_reason: String` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `type: :advisor_redacted_result` - `:advisor_redacted_result` - `tool_use_id: String` - `type: :advisor_tool_result` - `:advisor_tool_result` - `class BetaCodeExecutionToolResultBlock` - `content: BetaCodeExecutionToolResultBlockContent` Code execution result with encrypted stdout for PFC + web_search results. - `class BetaCodeExecutionToolResultError` - `error_code: BetaCodeExecutionToolResultErrorCode` - `:invalid_tool_input` - `:unavailable` - `:too_many_requests` - `:execution_time_exceeded` - `type: :code_execution_tool_result_error` - `:code_execution_tool_result_error` - `class BetaCodeExecutionResultBlock` - `content: Array[BetaCodeExecutionOutputBlock]` - `file_id: String` - `type: :code_execution_output` - `:code_execution_output` - `return_code: Integer` - `stderr: String` - `stdout: String` - `type: :code_execution_result` - `:code_execution_result` - `class BetaEncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `content: Array[BetaCodeExecutionOutputBlock]` - `file_id: String` - `type: :code_execution_output` - `encrypted_stdout: String` - `return_code: Integer` - `stderr: String` - `type: :encrypted_code_execution_result` - `:encrypted_code_execution_result` - `tool_use_id: String` - `type: :code_execution_tool_result` - `:code_execution_tool_result` - `class BetaBashCodeExecutionToolResultBlock` - `content: BetaBashCodeExecutionToolResultError | BetaBashCodeExecutionResultBlock` - `class BetaBashCodeExecutionToolResultError` - `error_code: :invalid_tool_input | :unavailable | :too_many_requests | 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` - `class BetaBashCodeExecutionResultBlock` - `content: Array[BetaBashCodeExecutionOutputBlock]` - `file_id: String` - `type: :bash_code_execution_output` - `:bash_code_execution_output` - `return_code: Integer` - `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` - `class BetaTextEditorCodeExecutionToolResultBlock` - `content: BetaTextEditorCodeExecutionToolResultError | BetaTextEditorCodeExecutionViewResultBlock | BetaTextEditorCodeExecutionCreateResultBlock | BetaTextEditorCodeExecutionStrReplaceResultBlock` - `class BetaTextEditorCodeExecutionToolResultError` - `error_code: :invalid_tool_input | :unavailable | :too_many_requests | 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` - `class BetaTextEditorCodeExecutionViewResultBlock` - `content: String` - `file_type: :text | :image | :pdf` - `:text` - `:image` - `:pdf` - `num_lines: Integer` - `start_line: Integer` - `total_lines: Integer` - `type: :text_editor_code_execution_view_result` - `:text_editor_code_execution_view_result` - `class BetaTextEditorCodeExecutionCreateResultBlock` - `is_file_update: bool` - `type: :text_editor_code_execution_create_result` - `:text_editor_code_execution_create_result` - `class BetaTextEditorCodeExecutionStrReplaceResultBlock` - `lines: Array[String]` - `new_lines: Integer` - `new_start: Integer` - `old_lines: Integer` - `old_start: Integer` - `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` - `class BetaToolSearchToolResultBlock` - `content: BetaToolSearchToolResultError | BetaToolSearchToolSearchResultBlock` - `class BetaToolSearchToolResultError` - `error_code: :invalid_tool_input | :unavailable | :too_many_requests | :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` - `class BetaToolSearchToolSearchResultBlock` - `tool_references: Array[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` - `class BetaMCPToolUseBlock` - `id: String` - `input: Hash[Symbol, untyped]` - `name: String` The name of the MCP tool - `server_name: String` The name of the MCP server - `type: :mcp_tool_use` - `:mcp_tool_use` - `class BetaMCPToolResultBlock` - `content: String | Array[BetaTextBlock]` - `String = String` - `BetaMCPToolResultBlockContent = Array[BetaTextBlock]` - `citations: Array[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: bool` - `tool_use_id: String` - `type: :mcp_tool_result` - `:mcp_tool_result` - `class BetaContainerUploadBlock` Response model for a file uploaded to the container. - `file_id: String` - `type: :container_upload` - `:container_upload` - `class BetaCompactionBlock` 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` - `class BetaFallbackBlock` Marks the point in `content` where one model's output gives way to the next. One block appears per hop where a preceding model actually ran this turn and declined. A turn routed directly by the sticky decision has no such boundary and carries no block — the signal for whether a fallback model served the response is the presence of a `fallback_message` entry in `usage.iterations`, not this block. The block is treated like a server-tool content block for streaming: it arrives via the standard `content_block_start` / `content_block_stop` pair and carries no deltas. - `from: BetaFallbackInfo` The model whose output ends at this point — the model that declined at this hop. When the declining hop is the requested model, its `model` echoes the top-level `model` string the caller sent (alias or canonical); when the declining hop is a fallback model, its `model` is that model's canonical id. - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `Model = :"claude-fable-5" | :"claude-mythos-5" | :"claude-opus-4-8" | 17 more` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `:"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `:"claude-mythos-5"` Most capable model for cybersecurity and biology research - `:"claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `:"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 = String` - `to: BetaFallbackInfo` The fallback model producing the content that follows this block. Its `model` is always the canonical id. - `type: :fallback` - `:fallback` - `context_management: BetaContextManagementResponse` Context management response. Information about context management strategies applied during the request. - `applied_edits: Array[BetaClearToolUses20250919EditResponse | BetaClearThinking20251015EditResponse]` List of context management edits that were applied. - `class BetaClearToolUses20250919EditResponse` - `cleared_input_tokens: Integer` Number of input tokens cleared by this edit. - `cleared_tool_uses: Integer` Number of tool uses that were cleared. - `type: :clear_tool_uses_20250919` The type of context management edit applied. - `:clear_tool_uses_20250919` - `class BetaClearThinking20251015EditResponse` - `cleared_input_tokens: Integer` Number of input tokens cleared by this edit. - `cleared_thinking_turns: Integer` 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 | BetaCacheMissSystemChanged | BetaCacheMissToolsChanged | 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. - `class BetaCacheMissModelChanged` - `cache_missed_input_tokens: Integer` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: :model_changed` - `:model_changed` - `class BetaCacheMissSystemChanged` - `cache_missed_input_tokens: Integer` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: :system_changed` - `:system_changed` - `class BetaCacheMissToolsChanged` - `cache_missed_input_tokens: Integer` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: :tools_changed` - `:tools_changed` - `class BetaCacheMissMessagesChanged` - `cache_missed_input_tokens: Integer` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: :messages_changed` - `:messages_changed` - `class BetaCacheMissPreviousMessageNotFound` - `type: :previous_message_not_found` - `:previous_message_not_found` - `class BetaCacheMissUnavailable` - `type: :unavailable` - `:unavailable` - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `role: :assistant` Conversational role of the generated message. This will always be `"assistant"`. - `:assistant` - `stop_details: BetaRefusalStopDetails` Structured information about a refusal. - `category: :cyber | :bio | :reasoning_extraction` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `:cyber` - `:bio` - `:reasoning_extraction` - `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. - `fallback_credit_token: String` Opaque code that refunds the cache-miss cost when retrying this refused request on the fallback model. Pass it as `fallback_credit_token` on the retry request. Expires 5 minutes after the refusal. The retry is sent either with the same request body (`system`, `messages`, `tools`, and other render-shaping fields), or with the same body plus one appended `assistant` message whose content is the partial text (with any trailing whitespace stripped from the final text block) and paired server-tool blocks from this refusal — which also authorizes that appended turn as an assistant-prefill continuation on models that otherwise disallow prefill. A token minted mid-server-tool-loop whose partial content was continuable may only be redeemed the second way — if a same-body retry is rejected with a 400 saying the token must be redeemed by continuing the partial response, retry the second way instead. Either way: same workspace, same platform; a mismatch is a 400. Resending a token for an already-warm prefix is permitted but yields no additional credit. `null` when the refused model isn't eligible for a fallback credit. - `fallback_has_prefill_claim: bool` Whether the accompanying `fallback_credit_token` may be redeemed with the appended-assistant retry form. Only set when `fallback_credit_token` is present. `true`: retry by resending the same request body plus one appended `assistant` message whose content is this response's `content` with any trailing whitespace stripped from the final text block and unpaired `tool_use` blocks omitted (the same appended-turn shape described on `fallback_credit_token`), with the token attached. `false`: retry by resending the original request body unchanged, with the token attached — the appended-assistant form is not available for this refusal (no continuable partial content, or the request uses `output_format` or a `tool_choice` that forces tool use). One exception: when the request used `output_format` or a forced `tool_choice` and the refusal arrived after server tools (including MCP connector tools) had already executed, the token may not be redeemable by either retry form; if the exact-body retry is then rejected with a 400 saying the token must be redeemed by continuing the partial response, discard the token and retry without it. Advisory: if an appended-assistant retry is rejected with a 400 despite `true`, fall back to resending the original request body with the token. - `recommended_model: String` The server's suggested retry target for this refusal. Populated when a fallback attempt could not be made (the fallback model's rate limit was exhausted, or it was overloaded); names the fallback model the caller can retry directly. Null otherwise. - `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: Integer` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: Integer` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: Integer` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: Integer` The number of input tokens read from the cache. - `inference_geo: String` The geographic region where inference was performed for this request. - `input_tokens: Integer` 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 - `class BetaMessageIterationUsage` Token usage for a sampling iteration. - `cache_creation: BetaCacheCreation` Breakdown of cached tokens by TTL - `cache_creation_input_tokens: Integer` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: Integer` The number of input tokens read from the cache. - `input_tokens: Integer` The number of input tokens which were used. - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: Integer` The number of output tokens which were used. - `type: :message` Usage for a sampling iteration - `:message` - `class BetaCompactionIterationUsage` Token usage for a compaction iteration. - `cache_creation: BetaCacheCreation` Breakdown of cached tokens by TTL - `cache_creation_input_tokens: Integer` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: Integer` The number of input tokens read from the cache. - `input_tokens: Integer` The number of input tokens which were used. - `output_tokens: Integer` The number of output tokens which were used. - `type: :compaction` Usage for a compaction iteration - `:compaction` - `class BetaAdvisorMessageIterationUsage` Token usage for an advisor sub-inference iteration. - `cache_creation: BetaCacheCreation` Breakdown of cached tokens by TTL - `cache_creation_input_tokens: Integer` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: Integer` The number of input tokens read from the cache. - `input_tokens: Integer` The number of input tokens which were used. - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: Integer` The number of output tokens which were used. - `type: :advisor_message` Usage for an advisor sub-inference iteration - `:advisor_message` - `class BetaFallbackMessageIterationUsage` Token usage for the fallback-model attempt of a server-side fallback request. Produced in place of a `message` entry for whichever hop served the response. A declined hop produces the existing `message` entry. Whether a fallback model served the response is signalled by the presence of this entry in `usage.iterations`. - `cache_creation: BetaCacheCreation` Breakdown of cached tokens by TTL - `cache_creation_input_tokens: Integer` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: Integer` The number of input tokens read from the cache. - `input_tokens: Integer` The number of input tokens which were used. - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: Integer` The number of output tokens which were used. - `type: :fallback_message` Usage for the fallback-model attempt that served the response - `:fallback_message` - `output_tokens: Integer` The number of output tokens which were used. - `output_tokens_details: BetaOutputTokensDetails` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `thinking_tokens: Integer` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. - `server_tool_use: BetaServerToolUsage` The number of server tool requests. - `web_fetch_requests: Integer` The number of web fetch tool requests. - `web_search_requests: Integer` The number of web search tool requests. - `service_tier: :standard | :priority | :batch` If the request used the priority, standard, or batch tier. - `:standard` - `:priority` - `:batch` - `speed: :standard | :fast` The inference speed mode used for this request. - `:standard` - `:fast` - `type: :succeeded` - `:succeeded` - `class BetaMessageBatchErroredResult` - `error: BetaErrorResponse` - `error: BetaError` - `class BetaInvalidRequestError` - `message: String` - `type: :invalid_request_error` - `:invalid_request_error` - `class BetaAuthenticationError` - `message: String` - `type: :authentication_error` - `:authentication_error` - `class BetaBillingError` - `message: String` - `type: :billing_error` - `:billing_error` - `class BetaPermissionError` - `message: String` - `type: :permission_error` - `:permission_error` - `class BetaNotFoundError` - `message: String` - `type: :not_found_error` - `:not_found_error` - `class BetaRateLimitError` - `message: String` - `type: :rate_limit_error` - `:rate_limit_error` - `class BetaGatewayTimeoutError` - `message: String` - `type: :timeout_error` - `:timeout_error` - `class BetaAPIError` - `message: String` - `type: :api_error` - `:api_error` - `class BetaOverloadedError` - `message: String` - `type: :overloaded_error` - `:overloaded_error` - `request_id: String` - `type: :error` - `:error` - `type: :errored` - `:errored` - `class BetaMessageBatchCanceledResult` - `type: :canceled` - `:canceled` - `class BetaMessageBatchExpiredResult` - `type: :expired` - `:expired` ### Example ```ruby require "anthropic" anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") beta_message_batch_individual_response = anthropic.beta.messages.batches.results("message_batch_id") puts(beta_message_batch_individual_response) ```