# Messages ## Create a Message `client.beta.messages.create(MessageCreateParamsparams, RequestOptionsoptions?): BetaMessage | Stream` **post** `/v1/messages` Send a structured list of input messages with text and/or image content, and the model will generate the next message in the conversation. The Messages API can be used for either single queries or stateless multi-turn conversations. Learn more about the Messages API in our [user guide](https://docs.claude.com/en/docs/initial-setup) ### Parameters - `MessageCreateParams = MessageCreateParamsNonStreaming | MessageCreateParamsStreaming` - `MessageCreateParamsBase` - `max_tokens: number` Body param: The maximum number of tokens to generate before stopping. Note that our models may stop _before_ reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate. Set to `0` to populate the [prompt cache](https://docs.claude.com/en/docs/build-with-claude/prompt-caching#pre-warming-the-cache) without generating a response. Different models have different maximum values for this parameter. See [models](https://docs.claude.com/en/docs/models-overview) for details. - `messages: Array` Body param: Input messages. Our models are trained to operate on alternating `user` and `assistant` conversational turns. When creating a new `Message`, you specify the prior conversational turns with the `messages` parameter, and the model then generates the next `Message` in the conversation. Consecutive `user` or `assistant` turns in your request will be combined into a single turn. Each input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages. If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. Example with a single `user` message: ```json [{"role": "user", "content": "Hello, Claude"}] ``` Example with multiple conversational turns: ```json [ {"role": "user", "content": "Hello there."}, {"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"}, {"role": "user", "content": "Can you explain LLMs in plain English?"}, ] ``` Example with a partially-filled response from Claude: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("}, ] ``` Each input message `content` may be either a single `string` or an array of content blocks, where each block has a specific `type`. Using a `string` for `content` is shorthand for an array of one content block of type `"text"`. The following input messages are equivalent: ```json {"role": "user", "content": "Hello, Claude"} ``` ```json {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]} ``` See [input examples](https://docs.claude.com/en/api/messages-examples). Note that if you want to include a [system prompt](https://docs.claude.com/en/docs/system-prompts), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API. There is a limit of 100,000 messages in a single request. - `content: string | Array` - `string` - `Array` - `BetaTextBlockParam` - `text: string` - `type: "text"` - `"text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `citations?: Array | null` - `BetaCitationCharLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `BetaCitationContentBlockLocationParam` - `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 | null` - `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`. - `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"` - `BetaCitationWebSearchResultLocationParam` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `BetaCitationSearchResultLocationParam` - `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 | null` - `type: "search_result_location"` - `"search_result_location"` - `BetaImageBlockParam` - `source: BetaBase64ImageSource | BetaURLImageSource | BetaFileImageSource` - `BetaBase64ImageSource` - `data: string` - `media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `type: "base64"` - `"base64"` - `BetaURLImageSource` - `type: "url"` - `"url"` - `url: string` - `BetaFileImageSource` - `file_id: string` - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaRequestDocumentBlock` - `source: BetaBase64PDFSource | BetaPlainTextSource | BetaContentBlockSource | 2 more` - `BetaBase64PDFSource` - `data: string` - `media_type: "application/pdf"` - `"application/pdf"` - `type: "base64"` - `"base64"` - `BetaPlainTextSource` - `data: string` - `media_type: "text/plain"` - `"text/plain"` - `type: "text"` - `"text"` - `BetaContentBlockSource` - `content: string | Array` - `string` - `Array` - `BetaTextBlockParam` - `BetaImageBlockParam` - `type: "content"` - `"content"` - `BetaURLPDFSource` - `type: "url"` - `"url"` - `url: string` - `BetaFileDocumentSource` - `file_id: string` - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam | null` - `enabled?: boolean` - `context?: string | null` - `title?: string | null` - `BetaSearchResultBlockParam` - `content: Array` - `text: string` - `type: "text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `source: string` - `title: string` - `type: "search_result"` - `"search_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam` - `BetaThinkingBlockParam` - `signature: string` - `thinking: string` - `type: "thinking"` - `"thinking"` - `BetaRedactedThinkingBlockParam` - `data: string` - `type: "redacted_thinking"` - `"redacted_thinking"` - `BetaToolUseBlockParam` - `id: string` - `input: Record` - `name: string` - `type: "tool_use"` - `"tool_use"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `type: "direct"` - `"direct"` - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `BetaServerToolCaller20260120` - `tool_id: string` - `type: "code_execution_20260120"` - `"code_execution_20260120"` - `BetaToolResultBlockParam` - `tool_use_id: string` - `type: "tool_result"` - `"tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `content?: string | Array` - `string` - `Array` - `BetaTextBlockParam` - `BetaImageBlockParam` - `BetaSearchResultBlockParam` - `BetaRequestDocumentBlock` - `BetaToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `tool_name: string` - `type: "tool_reference"` - `"tool_reference"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `is_error?: boolean` - `BetaServerToolUseBlockParam` - `id: string` - `input: Record` - `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"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebSearchToolResultBlockParam` - `content: BetaWebSearchToolResultBlockParamContent` - `Array` - `encrypted_content: string` - `title: string` - `type: "web_search_result"` - `"web_search_result"` - `url: string` - `page_age?: string | null` - `BetaWebSearchToolRequestError` - `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"` - `tool_use_id: string` - `type: "web_search_tool_result"` - `"web_search_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebFetchToolResultBlockParam` - `content: BetaWebFetchToolResultErrorBlockParam | BetaWebFetchBlockParam` - `BetaWebFetchToolResultErrorBlockParam` - `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"` - `BetaWebFetchBlockParam` - `content: BetaRequestDocumentBlock` - `type: "web_fetch_result"` - `"web_fetch_result"` - `url: string` Fetched content URL - `retrieved_at?: string | null` ISO 8601 timestamp when the content was retrieved - `tool_use_id: string` - `type: "web_fetch_tool_result"` - `"web_fetch_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaAdvisorToolResultBlockParam` - `content: BetaAdvisorToolResultErrorParam | BetaAdvisorResultBlockParam | BetaAdvisorRedactedResultBlockParam` - `BetaAdvisorToolResultErrorParam` - `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"` - `BetaAdvisorResultBlockParam` - `text: string` - `type: "advisor_result"` - `"advisor_result"` - `stop_reason?: string | null` - `BetaAdvisorRedactedResultBlockParam` - `encrypted_content: string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `type: "advisor_redacted_result"` - `"advisor_redacted_result"` - `stop_reason?: string | null` - `tool_use_id: string` - `type: "advisor_tool_result"` - `"advisor_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaCodeExecutionToolResultBlockParam` - `content: BetaCodeExecutionToolResultBlockParamContent` Code execution result with encrypted stdout for PFC + web_search results. - `BetaCodeExecutionToolResultErrorParam` - `error_code: BetaCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `type: "code_execution_tool_result_error"` - `"code_execution_tool_result_error"` - `BetaCodeExecutionResultBlockParam` - `content: Array` - `file_id: string` - `type: "code_execution_output"` - `"code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "code_execution_result"` - `"code_execution_result"` - `BetaEncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `content: Array` - `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"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaBashCodeExecutionToolResultBlockParam` - `content: BetaBashCodeExecutionToolResultErrorParam | BetaBashCodeExecutionResultBlockParam` - `BetaBashCodeExecutionToolResultErrorParam` - `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"` - `BetaBashCodeExecutionResultBlockParam` - `content: Array` - `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"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaTextEditorCodeExecutionToolResultBlockParam` - `content: BetaTextEditorCodeExecutionToolResultErrorParam | BetaTextEditorCodeExecutionViewResultBlockParam | BetaTextEditorCodeExecutionCreateResultBlockParam | BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `BetaTextEditorCodeExecutionToolResultErrorParam` - `error_code: "invalid_tool_input" | "unavailable" | "too_many_requests" | 2 more` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `type: "text_editor_code_execution_tool_result_error"` - `"text_editor_code_execution_tool_result_error"` - `error_message?: string | null` - `BetaTextEditorCodeExecutionViewResultBlockParam` - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `type: "text_editor_code_execution_view_result"` - `"text_editor_code_execution_view_result"` - `num_lines?: number | null` - `start_line?: number | null` - `total_lines?: number | null` - `BetaTextEditorCodeExecutionCreateResultBlockParam` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `"text_editor_code_execution_create_result"` - `BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `type: "text_editor_code_execution_str_replace_result"` - `"text_editor_code_execution_str_replace_result"` - `lines?: Array | null` - `new_lines?: number | null` - `new_start?: number | null` - `old_lines?: number | null` - `old_start?: number | null` - `tool_use_id: string` - `type: "text_editor_code_execution_tool_result"` - `"text_editor_code_execution_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaToolSearchToolResultBlockParam` - `content: BetaToolSearchToolResultErrorParam | BetaToolSearchToolSearchResultBlockParam` - `BetaToolSearchToolResultErrorParam` - `error_code: "invalid_tool_input" | "unavailable" | "too_many_requests" | "execution_time_exceeded"` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `type: "tool_search_tool_result_error"` - `"tool_search_tool_result_error"` - `error_message?: string | null` - `BetaToolSearchToolSearchResultBlockParam` - `tool_references: Array` - `tool_name: string` - `type: "tool_reference"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "tool_search_tool_search_result"` - `"tool_search_tool_search_result"` - `tool_use_id: string` - `type: "tool_search_tool_result"` - `"tool_search_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaMCPToolUseBlockParam` - `id: string` - `input: Record` - `name: string` - `server_name: string` The name of the MCP server - `type: "mcp_tool_use"` - `"mcp_tool_use"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaRequestMCPToolResultBlockParam` - `tool_use_id: string` - `type: "mcp_tool_result"` - `"mcp_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `content?: string | Array` - `string` - `Array` - `text: string` - `type: "text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `is_error?: boolean` - `BetaContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `file_id: string` - `type: "container_upload"` - `"container_upload"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaCompactionBlockParam` A compaction block containing summary of previous context. Users should round-trip these blocks from responses to subsequent requests to maintain context across compaction boundaries. When content is None, the block represents a failed compaction. The server treats these as no-ops. Empty string content is not allowed. - `type: "compaction"` - `"compaction"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `content?: string | null` Summary of previously compacted content, or null if compaction failed - `encrypted_content?: string | null` Opaque metadata from prior compaction, to be round-tripped verbatim - `BetaMidConversationSystemBlockParam` System instructions that appear mid-conversation. Use this block to provide or update system-level instructions at a specific point in the conversation, rather than only via the top-level `system` parameter. - `content: Array` System instruction text blocks. - `text: string` - `type: "text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `type: "mid_conv_system"` - `"mid_conv_system"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaFallbackBlockParam` A `fallback` block echoed back from a prior response. Accepted in `messages[].content` and never rendered into the prompt, not validated against the request's `fallbacks` chain or top-level `model`, and stripped before the sticky-routing cache key is computed. Callers should echo the assistant turn verbatim — block included. The block's position is load-bearing for thinking verification: the thinking runs on either side of a fallback hop carry independently-rooted verification hash chains, and this block is the only record of where one chain ends and the next begins. When thinking runs flank the boundary, omitting the block merges the runs into one contiguous span whose hashes cannot verify (the request is rejected), and moving it into the middle of a single run splits that run's chain and is likewise rejected; between non-thinking blocks the block's placement has no verification effect. - `from: BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `model: Model` 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" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` - `to: BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `type: "fallback"` - `"fallback"` - `role: "user" | "assistant" | "system"` - `"user"` - `"assistant"` - `"system"` - `model: Model` Body param: The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `cache_control?: BetaCacheControlEphemeral | null` Body param: Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request. - `container?: BetaContainerParams | string | null` Body param: Container identifier for reuse across requests. - `BetaContainerParams` Container parameters with skills to be loaded. - `id?: string | null` Container id - `skills?: Array | null` List of skills to load 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 - `string` - `context_management?: BetaContextManagementConfig | null` Body param: Context management configuration. This allows you to control how Claude manages context across multiple requests, such as whether to clear function results or not. - `edits?: Array` List of context management edits to apply - `BetaClearToolUses20250919Edit` - `type: "clear_tool_uses_20250919"` - `"clear_tool_uses_20250919"` - `clear_at_least?: BetaInputTokensClearAtLeast | null` Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed. - `type: "input_tokens"` - `"input_tokens"` - `value: number` - `clear_tool_inputs?: boolean | Array | null` Whether to clear all tool inputs (bool) or specific tool inputs to clear (list) - `boolean` - `Array` - `exclude_tools?: Array | null` Tool names whose uses are preserved from clearing - `keep?: BetaToolUsesKeep` Number of tool uses to retain in the conversation - `type: "tool_uses"` - `"tool_uses"` - `value: number` - `trigger?: BetaInputTokensTrigger | BetaToolUsesTrigger` Condition that triggers the context management strategy - `BetaInputTokensTrigger` - `type: "input_tokens"` - `"input_tokens"` - `value: number` - `BetaToolUsesTrigger` - `type: "tool_uses"` - `"tool_uses"` - `value: number` - `BetaClearThinking20251015Edit` - `type: "clear_thinking_20251015"` - `"clear_thinking_20251015"` - `keep?: BetaThinkingTurns | BetaAllThinkingTurns | "all"` Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed. - `BetaThinkingTurns` - `type: "thinking_turns"` - `"thinking_turns"` - `value: number` - `BetaAllThinkingTurns` - `type: "all"` - `"all"` - `"all"` - `"all"` - `BetaCompact20260112Edit` Automatically compact older context when reaching the configured trigger threshold. - `type: "compact_20260112"` - `"compact_20260112"` - `instructions?: string | null` Additional instructions for summarization. - `pause_after_compaction?: boolean` Whether to pause after compaction and return the compaction block to the user. - `trigger?: BetaInputTokensTrigger | null` When to trigger compaction. Defaults to 150000 input tokens. - `diagnostics?: BetaDiagnosticsParam | null` Body param: Request-level diagnostics. Currently carries the previous response id for prompt-cache divergence reporting. - `previous_message_id?: string | null` The `id` (`msg_...`) from this client's previous /v1/messages response. The server compares that request's prompt fingerprint against this one and returns `diagnostics.cache_miss_reason` when the prompt-cache prefix could not be reused. Pass `null` on the first turn to opt in without a prior message to compare. - `fallback_credit_token?: string | null` Body param: The `fallback_credit_token` from a prior refusal's `stop_details`. When a preceding request was refused and returned a `fallback_credit_token`, pass that code here on the retry to have the retry's cache-creation tokens for the prefix that was warm on the refused model billed at the cache-read rate. Must be redeemed by the same organization and workspace, with the same request body (optionally extended by 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 streamed before the refusal; the appended-assistant form is not available for requests with `output_format` set or forced `tool_choice`), on an eligible fallback model, on the same platform, and within 5 minutes of the refusal; a mismatch is a 400. A token minted mid-server-tool-loop whose partial content was continuable may only be redeemed with the appended-assistant form — if an exact-body retry is rejected with a 400 saying the token must be redeemed by continuing the partial response, retry with the appended-assistant form instead. When the appended-assistant form is used on a model that otherwise disallows assistant-turn prefill, this token also authorizes that one prefill. - `fallbacks?: Array | null` Body param: Opt-in server-side retry on one or more substitute models when the requested model declines for policy reasons. Tried in order: if the first entry also declines, the second is tried, and so on. - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `max_tokens?: number | null` - `output_config?: BetaOutputConfig | null` - `effort?: "low" | "medium" | "high" | 2 more | null` All possible effort levels. - `"low"` - `"medium"` - `"high"` - `"xhigh"` - `"max"` - `format?: BetaJSONOutputFormat | null` A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) - `schema: Record` The JSON schema of the format - `type: "json_schema"` - `"json_schema"` - `task_budget?: BetaTokenTaskBudget | null` User-configurable total token budget across contexts. - `total: number` Total token budget across all contexts in the session. - `type: "tokens"` The budget type. Currently only 'tokens' is supported. - `"tokens"` - `remaining?: number | null` Remaining tokens in the budget. Use this to track usage across contexts when implementing compaction client-side. Defaults to total if not provided. - `speed?: "standard" | "fast" | null` - `"standard"` - `"fast"` - `thinking?: BetaThinkingConfigEnabled | BetaThinkingConfigDisabled | BetaThinkingConfigAdaptive | null` - `BetaThinkingConfigEnabled` - `budget_tokens: number` Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality. Must be ≥1024 and less than `max_tokens`. See [extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details. - `type: "enabled"` - `"enabled"` - `display?: "summarized" | "omitted" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. - `"summarized"` - `"omitted"` - `BetaThinkingConfigDisabled` - `type: "disabled"` - `"disabled"` - `BetaThinkingConfigAdaptive` - `type: "adaptive"` - `"adaptive"` - `display?: "summarized" | "omitted" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. - `"summarized"` - `"omitted"` - `inference_geo?: string | null` Body param: Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used. - `mcp_servers?: Array` Body param: MCP servers to be utilized in this request - `name: string` - `type: "url"` - `"url"` - `url: string` - `authorization_token?: string | null` - `tool_configuration?: BetaRequestMCPServerToolConfiguration | null` - `allowed_tools?: Array | null` - `enabled?: boolean | null` - `metadata?: BetaMetadata` Body param: An object describing metadata about the request. - `user_id?: string | null` An external identifier for the user who is associated with the request. This should be a uuid, hash value, or other opaque identifier. Anthropic may use this id to help detect abuse. Do not include any identifying information such as name, email address, or phone number. - `output_config?: BetaOutputConfig` Body param: Configuration options for the model's output, such as the output format. - `output_format?: BetaJSONOutputFormat | null` Body param: Deprecated: Use `output_config.format` instead. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) A schema to specify Claude's output format in responses. This parameter will be removed in a future release. - `service_tier?: "auto" | "standard_only"` Body param: Determines whether to use priority capacity (if available) or standard capacity for this request. Anthropic offers different levels of service for your API requests. See [service-tiers](https://docs.claude.com/en/api/service-tiers) for details. - `"auto"` - `"standard_only"` - `speed?: "standard" | "fast" | null` Body param: The inference speed mode for this request. `"fast"` enables high output-tokens-per-second inference. - `"standard"` - `"fast"` - `stop_sequences?: Array` Body param: Custom text sequences that will cause the model to stop generating. Our models will normally stop when they have naturally completed their turn, which will result in a response `stop_reason` of `"end_turn"`. If you want the model to stop generating when it encounters custom strings of text, you can use the `stop_sequences` parameter. If the model encounters one of the custom sequences, the response `stop_reason` value will be `"stop_sequence"` and the response `stop_sequence` value will contain the matched stop sequence. - `stream?: false` Body param: Whether to incrementally stream the response using server-sent events. See [streaming](https://docs.claude.com/en/api/messages-streaming) for details. - `false` - `system?: string | Array` Body param: System prompt. A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://docs.claude.com/en/docs/system-prompts). - `string` - `Array` - `text: string` - `type: "text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `temperature?: number` Body param: Amount of randomness injected into the response. Defaults to `1.0`. Ranges from `0.0` to `1.0`. Use `temperature` closer to `0.0` for analytical / multiple choice, and closer to `1.0` for creative and generative tasks. Note that even with `temperature` of `0.0`, the results will not be fully deterministic. - `thinking?: BetaThinkingConfigParam` Body param: Configuration for enabling Claude's extended thinking. When enabled, responses include `thinking` content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your `max_tokens` limit. See [extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details. - `BetaThinkingConfigEnabled` - `BetaThinkingConfigDisabled` - `BetaThinkingConfigAdaptive` - `tool_choice?: BetaToolChoice` Body param: How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. - `BetaToolChoiceAuto` The model will automatically decide whether to use tools. - `type: "auto"` - `"auto"` - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output at most one tool use. - `BetaToolChoiceAny` The model will use any available tools. - `type: "any"` - `"any"` - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `BetaToolChoiceTool` The model will use the specified tool with `tool_choice.name`. - `name: string` The name of the tool to use. - `type: "tool"` - `"tool"` - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `BetaToolChoiceNone` The model will not be allowed to use tools. - `type: "none"` - `"none"` - `tools?: Array` Body param: Definitions of tools that the model may use. If you include `tools` in your API request, the model may return `tool_use` content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using `tool_result` content blocks. There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://docs.claude.com/en/docs/agents-and-tools/tool-use/overview#server-tools), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://docs.claude.com/en/docs/agents-and-tools/tool-use/web-search-tool)). Each tool definition includes: * `name`: Name of the tool. * `description`: Optional, but strongly-recommended description of the tool. * `input_schema`: [JSON schema](https://json-schema.org/draft/2020-12) for the tool `input` shape that the model will produce in `tool_use` output content blocks. For example, if you defined `tools` as: ```json [ { "name": "get_stock_price", "description": "Get the current stock price for a given ticker symbol.", "input_schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "The stock ticker symbol, e.g. AAPL for Apple Inc." } }, "required": ["ticker"] } } ] ``` And then asked the model "What's the S&P 500 at today?", the model might produce `tool_use` content blocks in the response like this: ```json [ { "type": "tool_use", "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "name": "get_stock_price", "input": { "ticker": "^GSPC" } } ] ``` You might then run your `get_stock_price` tool with `{"ticker": "^GSPC"}` as an input, and return the following back to the model in a subsequent `user` message: ```json [ { "type": "tool_result", "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "content": "259.75 USD" } ] ``` Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output. See our [guide](https://docs.claude.com/en/docs/tool-use) for more details. - `BetaTool` - `input_schema: InputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `type: "object"` - `"object"` - `properties?: Record | null` - `required?: Array | null` - `name: string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `description?: string` Description of what this tool does. Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema. - `eager_input_streaming?: boolean | null` Enable eager input streaming for this tool. When true, tool input parameters will be streamed incrementally as they are generated, and types will be inferred on-the-fly rather than buffering the full JSON output. When false, streaming is disabled for this tool even if the fine-grained-tool-streaming beta is active. When null (default), uses the default behavior based on beta headers. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `type?: "custom" | null` - `"custom"` - `BetaToolBash20241022` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"bash"` - `type: "bash_20241022"` - `"bash_20241022"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolBash20250124` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"bash"` - `type: "bash_20250124"` - `"bash_20250124"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20250522` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"code_execution"` - `type: "code_execution_20250522"` - `"code_execution_20250522"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20250825` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"code_execution"` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"code_execution"` - `type: "code_execution_20260120"` - `"code_execution_20260120"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolComputerUse20241022` - `display_height_px: number` The height of the display in pixels. - `display_width_px: number` The width of the display in pixels. - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"computer"` - `type: "computer_20241022"` - `"computer_20241022"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number?: number | null` The X11 display number (e.g. 0, 1) for the display. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaMemoryTool20250818` - `name: "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"memory"` - `type: "memory_20250818"` - `"memory_20250818"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolComputerUse20250124` - `display_height_px: number` The height of the display in pixels. - `display_width_px: number` The width of the display in pixels. - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"computer"` - `type: "computer_20250124"` - `"computer_20250124"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number?: number | null` The X11 display number (e.g. 0, 1) for the display. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20241022` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"str_replace_editor"` - `type: "text_editor_20241022"` - `"text_editor_20241022"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolComputerUse20251124` - `display_height_px: number` The height of the display in pixels. - `display_width_px: number` The width of the display in pixels. - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"computer"` - `type: "computer_20251124"` - `"computer_20251124"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number?: number | null` The X11 display number (e.g. 0, 1) for the display. - `enable_zoom?: boolean` Whether to enable an action to take a zoomed-in screenshot of the screen. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20250124` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"str_replace_editor"` - `type: "text_editor_20250124"` - `"text_editor_20250124"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20250429` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"str_replace_based_edit_tool"` - `type: "text_editor_20250429"` - `"text_editor_20250429"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20250728` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"str_replace_based_edit_tool"` - `type: "text_editor_20250728"` - `"text_editor_20250728"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `max_characters?: number | null` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaWebSearchTool20250305` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"web_search"` - `type: "web_search_20250305"` - `"web_search_20250305"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: BetaUserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `type: "approximate"` - `"approximate"` - `city?: string | null` The city of the user. - `country?: string | null` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. - `region?: string | null` The region of the user. - `timezone?: string | null` The [IANA timezone](https://nodatime.org/TimeZones) of the user. - `BetaWebFetchTool20250910` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"web_fetch"` - `type: "web_fetch_20250910"` - `"web_fetch_20250910"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaWebSearchTool20260209` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"web_search"` - `type: "web_search_20260209"` - `"web_search_20260209"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: BetaUserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `BetaWebFetchTool20260209` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"web_fetch"` - `type: "web_fetch_20260209"` - `"web_fetch_20260209"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"web_fetch"` - `type: "web_fetch_20260309"` - `"web_fetch_20260309"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `use_cache?: boolean` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `BetaAdvisorTool20260301` - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `name: "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"advisor"` - `type: "advisor_20260301"` - `"advisor_20260301"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caching?: BetaCacheControlEphemeral | null` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_tokens?: number | null` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolSearchToolBm25_20251119` - `name: "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"tool_search_tool_bm25"` - `type: "tool_search_tool_bm25_20251119" | "tool_search_tool_bm25"` - `"tool_search_tool_bm25_20251119"` - `"tool_search_tool_bm25"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolSearchToolRegex20251119` - `name: "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"tool_search_tool_regex"` - `type: "tool_search_tool_regex_20251119" | "tool_search_tool_regex"` - `"tool_search_tool_regex_20251119"` - `"tool_search_tool_regex"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `mcp_server_name: string` Name of the MCP server to configure tools for - `type: "mcp_toolset"` - `"mcp_toolset"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `configs?: Record | null` Configuration overrides for specific tools, keyed by tool name - `defer_loading?: boolean` - `enabled?: boolean` - `default_config?: BetaMCPToolDefaultConfig` Default configuration applied to all tools from this server - `defer_loading?: boolean` - `enabled?: boolean` - `top_k?: number` Body param: Only sample from the top K options for each subsequent token. Used to remove "long tail" low probability responses. [Learn more technical details here](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277). Recommended for advanced use cases only. - `top_p?: number` Body param: Use nucleus sampling. In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by `top_p`. Recommended for advanced use cases only. - `user_profile_id?: string | null` Body param: The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. - `betas?: Array` Header param: Optional header to specify the beta version(s) you want to use. - `(string & {})` - `"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"` - `MessageCreateParamsNonStreaming extends MessageCreateParamsBase` - `stream?: false` Body param: Whether to incrementally stream the response using server-sent events. See [streaming](https://docs.claude.com/en/api/messages-streaming) for details. - `MessageCreateParamsStreaming extends MessageCreateParamsBase` - `stream: true` Body param: Whether to incrementally stream the response using server-sent events. See [streaming](https://docs.claude.com/en/api/messages-streaming) for details. - `true` ### Returns - `BetaMessage` - `id: string` Unique object identifier. The format and length of IDs may change over time. - `container: BetaContainer | null` 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 | null` 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` 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)"}] ``` - `BetaTextBlock` - `citations: Array | null` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `BetaCitationCharLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `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: number` - `document_title: string | null` - `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 | null` - `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` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `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: 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 | null` - `type: "search_result_location"` - `"search_result_location"` - `text: string` - `type: "text"` - `"text"` - `BetaThinkingBlock` - `signature: string` - `thinking: string` - `type: "thinking"` - `"thinking"` - `BetaRedactedThinkingBlock` - `data: string` - `type: "redacted_thinking"` - `"redacted_thinking"` - `BetaToolUseBlock` - `id: string` - `input: Record` - `name: string` - `type: "tool_use"` - `"tool_use"` - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `type: "direct"` - `"direct"` - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `BetaServerToolCaller20260120` - `tool_id: string` - `type: "code_execution_20260120"` - `"code_execution_20260120"` - `BetaServerToolUseBlock` - `id: string` - `input: Record` - `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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebSearchToolResultBlock` - `content: BetaWebSearchToolResultBlockContent` - `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"` - `Array` - `encrypted_content: string` - `page_age: string | null` - `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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebFetchToolResultBlock` - `content: BetaWebFetchToolResultErrorBlock | BetaWebFetchBlock` - `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"` - `BetaWebFetchBlock` - `content: BetaDocumentBlock` - `citations: BetaCitationConfig | null` Citation configuration for the document - `enabled: boolean` - `source: BetaBase64PDFSource | BetaPlainTextSource` - `BetaBase64PDFSource` - `data: string` - `media_type: "application/pdf"` - `"application/pdf"` - `type: "base64"` - `"base64"` - `BetaPlainTextSource` - `data: string` - `media_type: "text/plain"` - `"text/plain"` - `type: "text"` - `"text"` - `title: string | null` The title of the document - `type: "document"` - `"document"` - `retrieved_at: string | null` 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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaAdvisorToolResultBlock` - `content: BetaAdvisorToolResultError | BetaAdvisorResultBlock | BetaAdvisorRedactedResultBlock` - `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"` - `BetaAdvisorResultBlock` - `stop_reason: string | null` 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"` - `BetaAdvisorRedactedResultBlock` - `encrypted_content: string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `stop_reason: string | null` 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"` - `BetaCodeExecutionToolResultBlock` - `content: BetaCodeExecutionToolResultBlockContent` Code execution result with encrypted stdout for PFC + web_search results. - `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"` - `BetaCodeExecutionResultBlock` - `content: Array` - `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` Code execution result with encrypted stdout for PFC + web_search results. - `content: Array` - `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` - `content: BetaBashCodeExecutionToolResultError | BetaBashCodeExecutionResultBlock` - `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"` - `BetaBashCodeExecutionResultBlock` - `content: Array` - `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` - `content: BetaTextEditorCodeExecutionToolResultError | BetaTextEditorCodeExecutionViewResultBlock | BetaTextEditorCodeExecutionCreateResultBlock | BetaTextEditorCodeExecutionStrReplaceResultBlock` - `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 | null` - `type: "text_editor_code_execution_tool_result_error"` - `"text_editor_code_execution_tool_result_error"` - `BetaTextEditorCodeExecutionViewResultBlock` - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number | null` - `start_line: number | null` - `total_lines: number | null` - `type: "text_editor_code_execution_view_result"` - `"text_editor_code_execution_view_result"` - `BetaTextEditorCodeExecutionCreateResultBlock` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `"text_editor_code_execution_create_result"` - `BetaTextEditorCodeExecutionStrReplaceResultBlock` - `lines: Array | null` - `new_lines: number | null` - `new_start: number | null` - `old_lines: number | null` - `old_start: number | null` - `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` - `content: BetaToolSearchToolResultError | BetaToolSearchToolSearchResultBlock` - `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 | null` - `type: "tool_search_tool_result_error"` - `"tool_search_tool_result_error"` - `BetaToolSearchToolSearchResultBlock` - `tool_references: Array` - `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` - `id: string` - `input: Record` - `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` - `content: string | Array` - `string` - `Array` - `citations: Array | null` 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` Response model for a file uploaded to the container. - `file_id: string` - `type: "container_upload"` - `"container_upload"` - `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 | null` Summary of compacted content, or null if compaction failed - `encrypted_content: string | null` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction"` - `"compaction"` - `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. - `"claude-fable-5" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` - `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 | null` Context management response. Information about context management strategies applied during the request. - `applied_edits: Array` List of context management edits that were applied. - `BetaClearToolUses20250919EditResponse` - `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` - `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 | null` 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 | null` 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` - `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` - `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` - `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` - `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` - `type: "previous_message_not_found"` - `"previous_message_not_found"` - `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 | null` Structured information about a refusal. - `category: "cyber" | "bio" | "reasoning_extraction" | null` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` - `"bio"` - `"reasoning_extraction"` - `explanation: string | null` 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 | null` 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: boolean | null` 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 | null` 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 | null` 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 | null` 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 | null` 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 | null` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number | null` The number of input tokens read from the cache. - `inference_geo: string | null` The geographic region where inference was performed for this request. - `input_tokens: number` The number of input tokens which were used. - `iterations: BetaIterationsUsage | null` 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` Token usage for a sampling iteration. - `cache_creation: BetaCacheCreation | null` 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](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: number` The number of output tokens which were used. - `type: "message"` Usage for a sampling iteration - `"message"` - `BetaCompactionIterationUsage` Token usage for a compaction iteration. - `cache_creation: BetaCacheCreation | null` 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` Token usage for an advisor sub-inference iteration. - `cache_creation: BetaCacheCreation | null` 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](https://docs.anthropic.com/en/docs/models-overview) 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"` - `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 | null` 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](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: number` 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: number` The number of output tokens which were used. - `output_tokens_details: BetaOutputTokensDetails | null` 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: number` 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 | null` 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" | "priority" | "batch" | null` If the request used the priority, standard, or batch tier. - `"standard"` - `"priority"` - `"batch"` - `speed: "standard" | "fast" | null` The inference speed mode used for this request. - `"standard"` - `"fast"` ### Example ```typescript import Anthropic from '@anthropic-ai/sdk'; const client = new Anthropic({ apiKey: process.env['ANTHROPIC_API_KEY'], // This is the default and can be omitted }); const betaMessage = await client.beta.messages.create({ max_tokens: 1024, messages: [{ content: 'Hello, world', role: 'user' }], model: 'claude-opus-4-6', }); console.log(betaMessage.id); ``` #### Response ```json { "id": "msg_013Zva2CMHLNnXjNJJKqJ2EF", "container": { "id": "id", "expires_at": "2019-12-27T18:11:19.117Z", "skills": [ { "skill_id": "pdf", "type": "anthropic", "version": "latest" } ] }, "content": [ { "citations": [ { "cited_text": "cited_text", "document_index": 0, "document_title": "document_title", "end_char_index": 0, "file_id": "file_id", "start_char_index": 0, "type": "char_location" } ], "text": "Hi! My name is Claude.", "type": "text" } ], "context_management": { "applied_edits": [ { "cleared_input_tokens": 0, "cleared_tool_uses": 0, "type": "clear_tool_uses_20250919" } ] }, "diagnostics": { "cache_miss_reason": { "cache_missed_input_tokens": 0, "type": "model_changed" } }, "model": "claude-opus-4-6", "role": "assistant", "stop_details": { "category": "cyber", "explanation": "explanation", "fallback_credit_token": "fallback_credit_token", "fallback_has_prefill_claim": true, "recommended_model": "recommended_model", "type": "refusal" }, "stop_reason": "end_turn", "stop_sequence": null, "type": "message", "usage": { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_creation_input_tokens": 2051, "cache_read_input_tokens": 2051, "inference_geo": "inference_geo", "input_tokens": 2095, "iterations": [ { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_creation_input_tokens": 0, "cache_read_input_tokens": 0, "input_tokens": 0, "model": "claude-fable-5", "output_tokens": 0, "type": "message" } ], "output_tokens": 503, "output_tokens_details": { "thinking_tokens": 0 }, "server_tool_use": { "web_fetch_requests": 2, "web_search_requests": 0 }, "service_tier": "standard", "speed": "standard" } } ``` ## Count tokens in a Message `client.beta.messages.countTokens(MessageCountTokensParamsparams, RequestOptionsoptions?): BetaMessageTokensCount` **post** `/v1/messages/count_tokens` Count the number of tokens in a Message. The Token Count API can be used to count the number of tokens in a Message, including tools, images, and documents, without creating it. Learn more about token counting in our [user guide](https://docs.claude.com/en/docs/build-with-claude/token-counting) ### Parameters - `params: MessageCountTokensParams` - `messages: Array` Body param: Input messages. Our models are trained to operate on alternating `user` and `assistant` conversational turns. When creating a new `Message`, you specify the prior conversational turns with the `messages` parameter, and the model then generates the next `Message` in the conversation. Consecutive `user` or `assistant` turns in your request will be combined into a single turn. Each input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages. If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. Example with a single `user` message: ```json [{"role": "user", "content": "Hello, Claude"}] ``` Example with multiple conversational turns: ```json [ {"role": "user", "content": "Hello there."}, {"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"}, {"role": "user", "content": "Can you explain LLMs in plain English?"}, ] ``` Example with a partially-filled response from Claude: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("}, ] ``` Each input message `content` may be either a single `string` or an array of content blocks, where each block has a specific `type`. Using a `string` for `content` is shorthand for an array of one content block of type `"text"`. The following input messages are equivalent: ```json {"role": "user", "content": "Hello, Claude"} ``` ```json {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]} ``` See [input examples](https://docs.claude.com/en/api/messages-examples). Note that if you want to include a [system prompt](https://docs.claude.com/en/docs/system-prompts), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API. There is a limit of 100,000 messages in a single request. - `content: string | Array` - `string` - `Array` - `BetaTextBlockParam` - `text: string` - `type: "text"` - `"text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `citations?: Array | null` - `BetaCitationCharLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `BetaCitationContentBlockLocationParam` - `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 | null` - `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`. - `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"` - `BetaCitationWebSearchResultLocationParam` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `BetaCitationSearchResultLocationParam` - `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 | null` - `type: "search_result_location"` - `"search_result_location"` - `BetaImageBlockParam` - `source: BetaBase64ImageSource | BetaURLImageSource | BetaFileImageSource` - `BetaBase64ImageSource` - `data: string` - `media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `type: "base64"` - `"base64"` - `BetaURLImageSource` - `type: "url"` - `"url"` - `url: string` - `BetaFileImageSource` - `file_id: string` - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaRequestDocumentBlock` - `source: BetaBase64PDFSource | BetaPlainTextSource | BetaContentBlockSource | 2 more` - `BetaBase64PDFSource` - `data: string` - `media_type: "application/pdf"` - `"application/pdf"` - `type: "base64"` - `"base64"` - `BetaPlainTextSource` - `data: string` - `media_type: "text/plain"` - `"text/plain"` - `type: "text"` - `"text"` - `BetaContentBlockSource` - `content: string | Array` - `string` - `Array` - `BetaTextBlockParam` - `BetaImageBlockParam` - `type: "content"` - `"content"` - `BetaURLPDFSource` - `type: "url"` - `"url"` - `url: string` - `BetaFileDocumentSource` - `file_id: string` - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam | null` - `enabled?: boolean` - `context?: string | null` - `title?: string | null` - `BetaSearchResultBlockParam` - `content: Array` - `text: string` - `type: "text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `source: string` - `title: string` - `type: "search_result"` - `"search_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam` - `BetaThinkingBlockParam` - `signature: string` - `thinking: string` - `type: "thinking"` - `"thinking"` - `BetaRedactedThinkingBlockParam` - `data: string` - `type: "redacted_thinking"` - `"redacted_thinking"` - `BetaToolUseBlockParam` - `id: string` - `input: Record` - `name: string` - `type: "tool_use"` - `"tool_use"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `type: "direct"` - `"direct"` - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `BetaServerToolCaller20260120` - `tool_id: string` - `type: "code_execution_20260120"` - `"code_execution_20260120"` - `BetaToolResultBlockParam` - `tool_use_id: string` - `type: "tool_result"` - `"tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `content?: string | Array` - `string` - `Array` - `BetaTextBlockParam` - `BetaImageBlockParam` - `BetaSearchResultBlockParam` - `BetaRequestDocumentBlock` - `BetaToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `tool_name: string` - `type: "tool_reference"` - `"tool_reference"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `is_error?: boolean` - `BetaServerToolUseBlockParam` - `id: string` - `input: Record` - `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"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebSearchToolResultBlockParam` - `content: BetaWebSearchToolResultBlockParamContent` - `Array` - `encrypted_content: string` - `title: string` - `type: "web_search_result"` - `"web_search_result"` - `url: string` - `page_age?: string | null` - `BetaWebSearchToolRequestError` - `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"` - `tool_use_id: string` - `type: "web_search_tool_result"` - `"web_search_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebFetchToolResultBlockParam` - `content: BetaWebFetchToolResultErrorBlockParam | BetaWebFetchBlockParam` - `BetaWebFetchToolResultErrorBlockParam` - `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"` - `BetaWebFetchBlockParam` - `content: BetaRequestDocumentBlock` - `type: "web_fetch_result"` - `"web_fetch_result"` - `url: string` Fetched content URL - `retrieved_at?: string | null` ISO 8601 timestamp when the content was retrieved - `tool_use_id: string` - `type: "web_fetch_tool_result"` - `"web_fetch_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaAdvisorToolResultBlockParam` - `content: BetaAdvisorToolResultErrorParam | BetaAdvisorResultBlockParam | BetaAdvisorRedactedResultBlockParam` - `BetaAdvisorToolResultErrorParam` - `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"` - `BetaAdvisorResultBlockParam` - `text: string` - `type: "advisor_result"` - `"advisor_result"` - `stop_reason?: string | null` - `BetaAdvisorRedactedResultBlockParam` - `encrypted_content: string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `type: "advisor_redacted_result"` - `"advisor_redacted_result"` - `stop_reason?: string | null` - `tool_use_id: string` - `type: "advisor_tool_result"` - `"advisor_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaCodeExecutionToolResultBlockParam` - `content: BetaCodeExecutionToolResultBlockParamContent` Code execution result with encrypted stdout for PFC + web_search results. - `BetaCodeExecutionToolResultErrorParam` - `error_code: BetaCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `type: "code_execution_tool_result_error"` - `"code_execution_tool_result_error"` - `BetaCodeExecutionResultBlockParam` - `content: Array` - `file_id: string` - `type: "code_execution_output"` - `"code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "code_execution_result"` - `"code_execution_result"` - `BetaEncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `content: Array` - `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"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaBashCodeExecutionToolResultBlockParam` - `content: BetaBashCodeExecutionToolResultErrorParam | BetaBashCodeExecutionResultBlockParam` - `BetaBashCodeExecutionToolResultErrorParam` - `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"` - `BetaBashCodeExecutionResultBlockParam` - `content: Array` - `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"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaTextEditorCodeExecutionToolResultBlockParam` - `content: BetaTextEditorCodeExecutionToolResultErrorParam | BetaTextEditorCodeExecutionViewResultBlockParam | BetaTextEditorCodeExecutionCreateResultBlockParam | BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `BetaTextEditorCodeExecutionToolResultErrorParam` - `error_code: "invalid_tool_input" | "unavailable" | "too_many_requests" | 2 more` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `type: "text_editor_code_execution_tool_result_error"` - `"text_editor_code_execution_tool_result_error"` - `error_message?: string | null` - `BetaTextEditorCodeExecutionViewResultBlockParam` - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `type: "text_editor_code_execution_view_result"` - `"text_editor_code_execution_view_result"` - `num_lines?: number | null` - `start_line?: number | null` - `total_lines?: number | null` - `BetaTextEditorCodeExecutionCreateResultBlockParam` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `"text_editor_code_execution_create_result"` - `BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `type: "text_editor_code_execution_str_replace_result"` - `"text_editor_code_execution_str_replace_result"` - `lines?: Array | null` - `new_lines?: number | null` - `new_start?: number | null` - `old_lines?: number | null` - `old_start?: number | null` - `tool_use_id: string` - `type: "text_editor_code_execution_tool_result"` - `"text_editor_code_execution_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaToolSearchToolResultBlockParam` - `content: BetaToolSearchToolResultErrorParam | BetaToolSearchToolSearchResultBlockParam` - `BetaToolSearchToolResultErrorParam` - `error_code: "invalid_tool_input" | "unavailable" | "too_many_requests" | "execution_time_exceeded"` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `type: "tool_search_tool_result_error"` - `"tool_search_tool_result_error"` - `error_message?: string | null` - `BetaToolSearchToolSearchResultBlockParam` - `tool_references: Array` - `tool_name: string` - `type: "tool_reference"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "tool_search_tool_search_result"` - `"tool_search_tool_search_result"` - `tool_use_id: string` - `type: "tool_search_tool_result"` - `"tool_search_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaMCPToolUseBlockParam` - `id: string` - `input: Record` - `name: string` - `server_name: string` The name of the MCP server - `type: "mcp_tool_use"` - `"mcp_tool_use"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaRequestMCPToolResultBlockParam` - `tool_use_id: string` - `type: "mcp_tool_result"` - `"mcp_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `content?: string | Array` - `string` - `Array` - `text: string` - `type: "text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `is_error?: boolean` - `BetaContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `file_id: string` - `type: "container_upload"` - `"container_upload"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaCompactionBlockParam` A compaction block containing summary of previous context. Users should round-trip these blocks from responses to subsequent requests to maintain context across compaction boundaries. When content is None, the block represents a failed compaction. The server treats these as no-ops. Empty string content is not allowed. - `type: "compaction"` - `"compaction"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `content?: string | null` Summary of previously compacted content, or null if compaction failed - `encrypted_content?: string | null` Opaque metadata from prior compaction, to be round-tripped verbatim - `BetaMidConversationSystemBlockParam` System instructions that appear mid-conversation. Use this block to provide or update system-level instructions at a specific point in the conversation, rather than only via the top-level `system` parameter. - `content: Array` System instruction text blocks. - `text: string` - `type: "text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `type: "mid_conv_system"` - `"mid_conv_system"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaFallbackBlockParam` A `fallback` block echoed back from a prior response. Accepted in `messages[].content` and never rendered into the prompt, not validated against the request's `fallbacks` chain or top-level `model`, and stripped before the sticky-routing cache key is computed. Callers should echo the assistant turn verbatim — block included. The block's position is load-bearing for thinking verification: the thinking runs on either side of a fallback hop carry independently-rooted verification hash chains, and this block is the only record of where one chain ends and the next begins. When thinking runs flank the boundary, omitting the block merges the runs into one contiguous span whose hashes cannot verify (the request is rejected), and moving it into the middle of a single run splits that run's chain and is likewise rejected; between non-thinking blocks the block's placement has no verification effect. - `from: BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `model: Model` 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" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` - `to: BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `type: "fallback"` - `"fallback"` - `role: "user" | "assistant" | "system"` - `"user"` - `"assistant"` - `"system"` - `model: Model` Body param: The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `cache_control?: BetaCacheControlEphemeral | null` Body param: Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request. - `context_management?: BetaContextManagementConfig | null` Body param: Context management configuration. This allows you to control how Claude manages context across multiple requests, such as whether to clear function results or not. - `edits?: Array` List of context management edits to apply - `BetaClearToolUses20250919Edit` - `type: "clear_tool_uses_20250919"` - `"clear_tool_uses_20250919"` - `clear_at_least?: BetaInputTokensClearAtLeast | null` Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed. - `type: "input_tokens"` - `"input_tokens"` - `value: number` - `clear_tool_inputs?: boolean | Array | null` Whether to clear all tool inputs (bool) or specific tool inputs to clear (list) - `boolean` - `Array` - `exclude_tools?: Array | null` Tool names whose uses are preserved from clearing - `keep?: BetaToolUsesKeep` Number of tool uses to retain in the conversation - `type: "tool_uses"` - `"tool_uses"` - `value: number` - `trigger?: BetaInputTokensTrigger | BetaToolUsesTrigger` Condition that triggers the context management strategy - `BetaInputTokensTrigger` - `type: "input_tokens"` - `"input_tokens"` - `value: number` - `BetaToolUsesTrigger` - `type: "tool_uses"` - `"tool_uses"` - `value: number` - `BetaClearThinking20251015Edit` - `type: "clear_thinking_20251015"` - `"clear_thinking_20251015"` - `keep?: BetaThinkingTurns | BetaAllThinkingTurns | "all"` Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed. - `BetaThinkingTurns` - `type: "thinking_turns"` - `"thinking_turns"` - `value: number` - `BetaAllThinkingTurns` - `type: "all"` - `"all"` - `"all"` - `"all"` - `BetaCompact20260112Edit` Automatically compact older context when reaching the configured trigger threshold. - `type: "compact_20260112"` - `"compact_20260112"` - `instructions?: string | null` Additional instructions for summarization. - `pause_after_compaction?: boolean` Whether to pause after compaction and return the compaction block to the user. - `trigger?: BetaInputTokensTrigger | null` When to trigger compaction. Defaults to 150000 input tokens. - `mcp_servers?: Array` Body param: MCP servers to be utilized in this request - `name: string` - `type: "url"` - `"url"` - `url: string` - `authorization_token?: string | null` - `tool_configuration?: BetaRequestMCPServerToolConfiguration | null` - `allowed_tools?: Array | null` - `enabled?: boolean | null` - `output_config?: BetaOutputConfig` Body param: Configuration options for the model's output, such as the output format. - `effort?: "low" | "medium" | "high" | 2 more | null` All possible effort levels. - `"low"` - `"medium"` - `"high"` - `"xhigh"` - `"max"` - `format?: BetaJSONOutputFormat | null` A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) - `schema: Record` The JSON schema of the format - `type: "json_schema"` - `"json_schema"` - `task_budget?: BetaTokenTaskBudget | null` User-configurable total token budget across contexts. - `total: number` Total token budget across all contexts in the session. - `type: "tokens"` The budget type. Currently only 'tokens' is supported. - `"tokens"` - `remaining?: number | null` Remaining tokens in the budget. Use this to track usage across contexts when implementing compaction client-side. Defaults to total if not provided. - `output_format?: BetaJSONOutputFormat | null` Body param: Deprecated: Use `output_config.format` instead. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) A schema to specify Claude's output format in responses. This parameter will be removed in a future release. - `speed?: "standard" | "fast" | null` Body param: The inference speed mode for this request. `"fast"` enables high output-tokens-per-second inference. - `"standard"` - `"fast"` - `system?: string | Array` Body param: System prompt. A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://docs.claude.com/en/docs/system-prompts). - `string` - `Array` - `text: string` - `type: "text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `thinking?: BetaThinkingConfigParam` Body param: Configuration for enabling Claude's extended thinking. When enabled, responses include `thinking` content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your `max_tokens` limit. See [extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details. - `BetaThinkingConfigEnabled` - `budget_tokens: number` Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality. Must be ≥1024 and less than `max_tokens`. See [extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details. - `type: "enabled"` - `"enabled"` - `display?: "summarized" | "omitted" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. - `"summarized"` - `"omitted"` - `BetaThinkingConfigDisabled` - `type: "disabled"` - `"disabled"` - `BetaThinkingConfigAdaptive` - `type: "adaptive"` - `"adaptive"` - `display?: "summarized" | "omitted" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. - `"summarized"` - `"omitted"` - `tool_choice?: BetaToolChoice` Body param: How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. - `BetaToolChoiceAuto` The model will automatically decide whether to use tools. - `type: "auto"` - `"auto"` - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output at most one tool use. - `BetaToolChoiceAny` The model will use any available tools. - `type: "any"` - `"any"` - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `BetaToolChoiceTool` The model will use the specified tool with `tool_choice.name`. - `name: string` The name of the tool to use. - `type: "tool"` - `"tool"` - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `BetaToolChoiceNone` The model will not be allowed to use tools. - `type: "none"` - `"none"` - `tools?: Array` Body param: Definitions of tools that the model may use. If you include `tools` in your API request, the model may return `tool_use` content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using `tool_result` content blocks. There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://docs.claude.com/en/docs/agents-and-tools/tool-use/overview#server-tools), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://docs.claude.com/en/docs/agents-and-tools/tool-use/web-search-tool)). Each tool definition includes: * `name`: Name of the tool. * `description`: Optional, but strongly-recommended description of the tool. * `input_schema`: [JSON schema](https://json-schema.org/draft/2020-12) for the tool `input` shape that the model will produce in `tool_use` output content blocks. For example, if you defined `tools` as: ```json [ { "name": "get_stock_price", "description": "Get the current stock price for a given ticker symbol.", "input_schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "The stock ticker symbol, e.g. AAPL for Apple Inc." } }, "required": ["ticker"] } } ] ``` And then asked the model "What's the S&P 500 at today?", the model might produce `tool_use` content blocks in the response like this: ```json [ { "type": "tool_use", "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "name": "get_stock_price", "input": { "ticker": "^GSPC" } } ] ``` You might then run your `get_stock_price` tool with `{"ticker": "^GSPC"}` as an input, and return the following back to the model in a subsequent `user` message: ```json [ { "type": "tool_result", "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "content": "259.75 USD" } ] ``` Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output. See our [guide](https://docs.claude.com/en/docs/tool-use) for more details. - `BetaTool` - `input_schema: InputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `type: "object"` - `"object"` - `properties?: Record | null` - `required?: Array | null` - `name: string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `description?: string` Description of what this tool does. Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema. - `eager_input_streaming?: boolean | null` Enable eager input streaming for this tool. When true, tool input parameters will be streamed incrementally as they are generated, and types will be inferred on-the-fly rather than buffering the full JSON output. When false, streaming is disabled for this tool even if the fine-grained-tool-streaming beta is active. When null (default), uses the default behavior based on beta headers. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `type?: "custom" | null` - `"custom"` - `BetaToolBash20241022` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"bash"` - `type: "bash_20241022"` - `"bash_20241022"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolBash20250124` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"bash"` - `type: "bash_20250124"` - `"bash_20250124"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20250522` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"code_execution"` - `type: "code_execution_20250522"` - `"code_execution_20250522"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20250825` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"code_execution"` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"code_execution"` - `type: "code_execution_20260120"` - `"code_execution_20260120"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolComputerUse20241022` - `display_height_px: number` The height of the display in pixels. - `display_width_px: number` The width of the display in pixels. - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"computer"` - `type: "computer_20241022"` - `"computer_20241022"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number?: number | null` The X11 display number (e.g. 0, 1) for the display. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaMemoryTool20250818` - `name: "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"memory"` - `type: "memory_20250818"` - `"memory_20250818"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolComputerUse20250124` - `display_height_px: number` The height of the display in pixels. - `display_width_px: number` The width of the display in pixels. - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"computer"` - `type: "computer_20250124"` - `"computer_20250124"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number?: number | null` The X11 display number (e.g. 0, 1) for the display. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20241022` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"str_replace_editor"` - `type: "text_editor_20241022"` - `"text_editor_20241022"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolComputerUse20251124` - `display_height_px: number` The height of the display in pixels. - `display_width_px: number` The width of the display in pixels. - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"computer"` - `type: "computer_20251124"` - `"computer_20251124"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number?: number | null` The X11 display number (e.g. 0, 1) for the display. - `enable_zoom?: boolean` Whether to enable an action to take a zoomed-in screenshot of the screen. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20250124` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"str_replace_editor"` - `type: "text_editor_20250124"` - `"text_editor_20250124"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20250429` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"str_replace_based_edit_tool"` - `type: "text_editor_20250429"` - `"text_editor_20250429"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20250728` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"str_replace_based_edit_tool"` - `type: "text_editor_20250728"` - `"text_editor_20250728"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `max_characters?: number | null` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaWebSearchTool20250305` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"web_search"` - `type: "web_search_20250305"` - `"web_search_20250305"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: BetaUserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `type: "approximate"` - `"approximate"` - `city?: string | null` The city of the user. - `country?: string | null` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. - `region?: string | null` The region of the user. - `timezone?: string | null` The [IANA timezone](https://nodatime.org/TimeZones) of the user. - `BetaWebFetchTool20250910` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"web_fetch"` - `type: "web_fetch_20250910"` - `"web_fetch_20250910"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaWebSearchTool20260209` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"web_search"` - `type: "web_search_20260209"` - `"web_search_20260209"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: BetaUserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `BetaWebFetchTool20260209` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"web_fetch"` - `type: "web_fetch_20260209"` - `"web_fetch_20260209"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"web_fetch"` - `type: "web_fetch_20260309"` - `"web_fetch_20260309"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `use_cache?: boolean` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `BetaAdvisorTool20260301` - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `name: "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"advisor"` - `type: "advisor_20260301"` - `"advisor_20260301"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caching?: BetaCacheControlEphemeral | null` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_tokens?: number | null` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolSearchToolBm25_20251119` - `name: "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"tool_search_tool_bm25"` - `type: "tool_search_tool_bm25_20251119" | "tool_search_tool_bm25"` - `"tool_search_tool_bm25_20251119"` - `"tool_search_tool_bm25"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolSearchToolRegex20251119` - `name: "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"tool_search_tool_regex"` - `type: "tool_search_tool_regex_20251119" | "tool_search_tool_regex"` - `"tool_search_tool_regex_20251119"` - `"tool_search_tool_regex"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `mcp_server_name: string` Name of the MCP server to configure tools for - `type: "mcp_toolset"` - `"mcp_toolset"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `configs?: Record | null` Configuration overrides for specific tools, keyed by tool name - `defer_loading?: boolean` - `enabled?: boolean` - `default_config?: BetaMCPToolDefaultConfig` Default configuration applied to all tools from this server - `defer_loading?: boolean` - `enabled?: boolean` - `betas?: Array` Header param: Optional header to specify the beta version(s) you want to use. - `(string & {})` - `"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 - `BetaMessageTokensCount` - `context_management: BetaCountTokensContextManagementResponse | null` Information about context management applied to the message. - `original_input_tokens: number` The original token count before context management was applied - `input_tokens: number` The total number of tokens across the provided list of messages, system prompt, and tools. ### Example ```typescript import Anthropic from '@anthropic-ai/sdk'; const client = new Anthropic({ apiKey: process.env['ANTHROPIC_API_KEY'], // This is the default and can be omitted }); const betaMessageTokensCount = await client.beta.messages.countTokens({ messages: [{ content: 'Hello, world', role: 'user' }], model: 'claude-opus-4-6', }); console.log(betaMessageTokensCount.context_management); ``` #### Response ```json { "context_management": { "original_input_tokens": 0 }, "input_tokens": 2095 } ``` ## Domain Types ### Beta Advisor Message Iteration Usage - `BetaAdvisorMessageIterationUsage` Token usage for an advisor sub-inference iteration. - `cache_creation: BetaCacheCreation | null` 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. - `input_tokens: number` 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. - `"claude-fable-5" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` - `output_tokens: number` The number of output tokens which were used. - `type: "advisor_message"` Usage for an advisor sub-inference iteration - `"advisor_message"` ### Beta Advisor Redacted Result Block - `BetaAdvisorRedactedResultBlock` - `encrypted_content: string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `stop_reason: string | null` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `type: "advisor_redacted_result"` - `"advisor_redacted_result"` ### Beta Advisor Redacted Result Block Param - `BetaAdvisorRedactedResultBlockParam` - `encrypted_content: string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `type: "advisor_redacted_result"` - `"advisor_redacted_result"` - `stop_reason?: string | null` ### Beta Advisor Result Block - `BetaAdvisorResultBlock` - `stop_reason: string | null` 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"` ### Beta Advisor Result Block Param - `BetaAdvisorResultBlockParam` - `text: string` - `type: "advisor_result"` - `"advisor_result"` - `stop_reason?: string | null` ### Beta Advisor Tool 20260301 - `BetaAdvisorTool20260301` - `model: Model` 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" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` - `name: "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"advisor"` - `type: "advisor_20260301"` - `"advisor_20260301"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `caching?: BetaCacheControlEphemeral | null` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_tokens?: number | null` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Beta Advisor Tool Result Block - `BetaAdvisorToolResultBlock` - `content: BetaAdvisorToolResultError | BetaAdvisorResultBlock | BetaAdvisorRedactedResultBlock` - `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"` - `BetaAdvisorResultBlock` - `stop_reason: string | null` 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"` - `BetaAdvisorRedactedResultBlock` - `encrypted_content: string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `stop_reason: string | null` 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"` ### Beta Advisor Tool Result Block Param - `BetaAdvisorToolResultBlockParam` - `content: BetaAdvisorToolResultErrorParam | BetaAdvisorResultBlockParam | BetaAdvisorRedactedResultBlockParam` - `BetaAdvisorToolResultErrorParam` - `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"` - `BetaAdvisorResultBlockParam` - `text: string` - `type: "advisor_result"` - `"advisor_result"` - `stop_reason?: string | null` - `BetaAdvisorRedactedResultBlockParam` - `encrypted_content: string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `type: "advisor_redacted_result"` - `"advisor_redacted_result"` - `stop_reason?: string | null` - `tool_use_id: string` - `type: "advisor_tool_result"` - `"advisor_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` ### Beta Advisor Tool Result Error - `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"` ### Beta Advisor Tool Result Error Param - `BetaAdvisorToolResultErrorParam` - `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"` ### Beta All Thinking Turns - `BetaAllThinkingTurns` - `type: "all"` - `"all"` ### Beta Base64 Image Source - `BetaBase64ImageSource` - `data: string` - `media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `type: "base64"` - `"base64"` ### Beta Base64 PDF Source - `BetaBase64PDFSource` - `data: string` - `media_type: "application/pdf"` - `"application/pdf"` - `type: "base64"` - `"base64"` ### Beta Bash Code Execution Output Block - `BetaBashCodeExecutionOutputBlock` - `file_id: string` - `type: "bash_code_execution_output"` - `"bash_code_execution_output"` ### Beta Bash Code Execution Output Block Param - `BetaBashCodeExecutionOutputBlockParam` - `file_id: string` - `type: "bash_code_execution_output"` - `"bash_code_execution_output"` ### Beta Bash Code Execution Result Block - `BetaBashCodeExecutionResultBlock` - `content: Array` - `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"` ### Beta Bash Code Execution Result Block Param - `BetaBashCodeExecutionResultBlockParam` - `content: Array` - `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"` ### Beta Bash Code Execution Tool Result Block - `BetaBashCodeExecutionToolResultBlock` - `content: BetaBashCodeExecutionToolResultError | BetaBashCodeExecutionResultBlock` - `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"` - `BetaBashCodeExecutionResultBlock` - `content: Array` - `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"` ### Beta Bash Code Execution Tool Result Block Param - `BetaBashCodeExecutionToolResultBlockParam` - `content: BetaBashCodeExecutionToolResultErrorParam | BetaBashCodeExecutionResultBlockParam` - `BetaBashCodeExecutionToolResultErrorParam` - `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"` - `BetaBashCodeExecutionResultBlockParam` - `content: Array` - `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"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` ### Beta Bash Code Execution Tool Result Error - `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"` ### Beta Bash Code Execution Tool Result Error Param - `BetaBashCodeExecutionToolResultErrorParam` - `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"` ### Beta Cache Control Ephemeral - `BetaCacheControlEphemeral` - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` ### Beta Cache Creation - `BetaCacheCreation` - `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. ### Beta Cache Miss Messages Changed - `BetaCacheMissMessagesChanged` - `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"` ### Beta Cache Miss Model Changed - `BetaCacheMissModelChanged` - `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"` ### Beta Cache Miss Previous Message Not Found - `BetaCacheMissPreviousMessageNotFound` - `type: "previous_message_not_found"` - `"previous_message_not_found"` ### Beta Cache Miss System Changed - `BetaCacheMissSystemChanged` - `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"` ### Beta Cache Miss Tools Changed - `BetaCacheMissToolsChanged` - `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"` ### Beta Cache Miss Unavailable - `BetaCacheMissUnavailable` - `type: "unavailable"` - `"unavailable"` ### Beta Citation Char Location - `BetaCitationCharLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` - `type: "char_location"` - `"char_location"` ### Beta Citation Char Location Param - `BetaCitationCharLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `"char_location"` ### Beta Citation Config - `BetaCitationConfig` - `enabled: boolean` ### Beta Citation Content Block Location - `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: number` - `document_title: string | null` - `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 | null` - `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"` ### Beta Citation Content Block Location Param - `BetaCitationContentBlockLocationParam` - `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 | null` - `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`. - `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"` ### Beta Citation Page Location - `BetaCitationPageLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` - `type: "page_location"` - `"page_location"` ### Beta Citation Page Location Param - `BetaCitationPageLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `"page_location"` ### Beta Citation Search Result Location - `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: 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 | null` - `type: "search_result_location"` - `"search_result_location"` ### Beta Citation Search Result Location Param - `BetaCitationSearchResultLocationParam` - `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 | null` - `type: "search_result_location"` - `"search_result_location"` ### Beta Citation Web Search Result Location Param - `BetaCitationWebSearchResultLocationParam` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` ### Beta Citations Config Param - `BetaCitationsConfigParam` - `enabled?: boolean` ### Beta Citations Delta - `BetaCitationsDelta` - `citation: BetaCitationCharLocation | BetaCitationPageLocation | BetaCitationContentBlockLocation | 2 more` - `BetaCitationCharLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `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: number` - `document_title: string | null` - `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 | null` - `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` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `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: 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 | null` - `type: "search_result_location"` - `"search_result_location"` - `type: "citations_delta"` - `"citations_delta"` ### Beta Citations Web Search Result Location - `BetaCitationsWebSearchResultLocation` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` ### Beta Clear Thinking 20251015 Edit - `BetaClearThinking20251015Edit` - `type: "clear_thinking_20251015"` - `"clear_thinking_20251015"` - `keep?: BetaThinkingTurns | BetaAllThinkingTurns | "all"` Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed. - `BetaThinkingTurns` - `type: "thinking_turns"` - `"thinking_turns"` - `value: number` - `BetaAllThinkingTurns` - `type: "all"` - `"all"` - `"all"` - `"all"` ### Beta Clear Thinking 20251015 Edit Response - `BetaClearThinking20251015EditResponse` - `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"` ### Beta Clear Tool Uses 20250919 Edit - `BetaClearToolUses20250919Edit` - `type: "clear_tool_uses_20250919"` - `"clear_tool_uses_20250919"` - `clear_at_least?: BetaInputTokensClearAtLeast | null` Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed. - `type: "input_tokens"` - `"input_tokens"` - `value: number` - `clear_tool_inputs?: boolean | Array | null` Whether to clear all tool inputs (bool) or specific tool inputs to clear (list) - `boolean` - `Array` - `exclude_tools?: Array | null` Tool names whose uses are preserved from clearing - `keep?: BetaToolUsesKeep` Number of tool uses to retain in the conversation - `type: "tool_uses"` - `"tool_uses"` - `value: number` - `trigger?: BetaInputTokensTrigger | BetaToolUsesTrigger` Condition that triggers the context management strategy - `BetaInputTokensTrigger` - `type: "input_tokens"` - `"input_tokens"` - `value: number` - `BetaToolUsesTrigger` - `type: "tool_uses"` - `"tool_uses"` - `value: number` ### Beta Clear Tool Uses 20250919 Edit Response - `BetaClearToolUses20250919EditResponse` - `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"` ### Beta Code Execution Output Block - `BetaCodeExecutionOutputBlock` - `file_id: string` - `type: "code_execution_output"` - `"code_execution_output"` ### Beta Code Execution Output Block Param - `BetaCodeExecutionOutputBlockParam` - `file_id: string` - `type: "code_execution_output"` - `"code_execution_output"` ### Beta Code Execution Result Block - `BetaCodeExecutionResultBlock` - `content: Array` - `file_id: string` - `type: "code_execution_output"` - `"code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "code_execution_result"` - `"code_execution_result"` ### Beta Code Execution Result Block Param - `BetaCodeExecutionResultBlockParam` - `content: Array` - `file_id: string` - `type: "code_execution_output"` - `"code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "code_execution_result"` - `"code_execution_result"` ### Beta Code Execution Tool 20250522 - `BetaCodeExecutionTool20250522` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"code_execution"` - `type: "code_execution_20250522"` - `"code_execution_20250522"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Beta Code Execution Tool 20250825 - `BetaCodeExecutionTool20250825` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"code_execution"` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Beta Code Execution Tool 20260120 - `BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"code_execution"` - `type: "code_execution_20260120"` - `"code_execution_20260120"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Beta Code Execution Tool Result Block - `BetaCodeExecutionToolResultBlock` - `content: BetaCodeExecutionToolResultBlockContent` Code execution result with encrypted stdout for PFC + web_search results. - `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"` - `BetaCodeExecutionResultBlock` - `content: Array` - `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` Code execution result with encrypted stdout for PFC + web_search results. - `content: Array` - `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"` ### Beta Code Execution Tool Result Block Content - `BetaCodeExecutionToolResultBlockContent = BetaCodeExecutionToolResultError | BetaCodeExecutionResultBlock | BetaEncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `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"` - `BetaCodeExecutionResultBlock` - `content: Array` - `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` Code execution result with encrypted stdout for PFC + web_search results. - `content: Array` - `file_id: string` - `type: "code_execution_output"` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `type: "encrypted_code_execution_result"` - `"encrypted_code_execution_result"` ### Beta Code Execution Tool Result Block Param - `BetaCodeExecutionToolResultBlockParam` - `content: BetaCodeExecutionToolResultBlockParamContent` Code execution result with encrypted stdout for PFC + web_search results. - `BetaCodeExecutionToolResultErrorParam` - `error_code: BetaCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `type: "code_execution_tool_result_error"` - `"code_execution_tool_result_error"` - `BetaCodeExecutionResultBlockParam` - `content: Array` - `file_id: string` - `type: "code_execution_output"` - `"code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "code_execution_result"` - `"code_execution_result"` - `BetaEncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `content: Array` - `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"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` ### Beta Code Execution Tool Result Block Param Content - `BetaCodeExecutionToolResultBlockParamContent = BetaCodeExecutionToolResultErrorParam | BetaCodeExecutionResultBlockParam | BetaEncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `BetaCodeExecutionToolResultErrorParam` - `error_code: BetaCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `type: "code_execution_tool_result_error"` - `"code_execution_tool_result_error"` - `BetaCodeExecutionResultBlockParam` - `content: Array` - `file_id: string` - `type: "code_execution_output"` - `"code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "code_execution_result"` - `"code_execution_result"` - `BetaEncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `content: Array` - `file_id: string` - `type: "code_execution_output"` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `type: "encrypted_code_execution_result"` - `"encrypted_code_execution_result"` ### Beta Code Execution Tool Result Error - `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"` ### Beta Code Execution Tool Result Error Code - `BetaCodeExecutionToolResultErrorCode = "invalid_tool_input" | "unavailable" | "too_many_requests" | "execution_time_exceeded"` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` ### Beta Code Execution Tool Result Error Param - `BetaCodeExecutionToolResultErrorParam` - `error_code: BetaCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `type: "code_execution_tool_result_error"` - `"code_execution_tool_result_error"` ### Beta Compact 20260112 Edit - `BetaCompact20260112Edit` Automatically compact older context when reaching the configured trigger threshold. - `type: "compact_20260112"` - `"compact_20260112"` - `instructions?: string | null` Additional instructions for summarization. - `pause_after_compaction?: boolean` Whether to pause after compaction and return the compaction block to the user. - `trigger?: BetaInputTokensTrigger | null` When to trigger compaction. Defaults to 150000 input tokens. - `type: "input_tokens"` - `"input_tokens"` - `value: number` ### Beta Compaction Block - `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 | null` Summary of compacted content, or null if compaction failed - `encrypted_content: string | null` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction"` - `"compaction"` ### Beta Compaction Block Param - `BetaCompactionBlockParam` A compaction block containing summary of previous context. Users should round-trip these blocks from responses to subsequent requests to maintain context across compaction boundaries. When content is None, the block represents a failed compaction. The server treats these as no-ops. Empty string content is not allowed. - `type: "compaction"` - `"compaction"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `content?: string | null` Summary of previously compacted content, or null if compaction failed - `encrypted_content?: string | null` Opaque metadata from prior compaction, to be round-tripped verbatim ### Beta Compaction Content Block Delta - `BetaCompactionContentBlockDelta` - `content: string | null` - `encrypted_content: string | null` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction_delta"` - `"compaction_delta"` ### Beta Compaction Iteration Usage - `BetaCompactionIterationUsage` Token usage for a compaction iteration. - `cache_creation: BetaCacheCreation | null` 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. - `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"` ### Beta 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 | null` 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 ### Beta Container Params - `BetaContainerParams` Container parameters with skills to be loaded. - `id?: string | null` Container id - `skills?: Array | null` List of skills to load 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 ### Beta Container Upload Block - `BetaContainerUploadBlock` Response model for a file uploaded to the container. - `file_id: string` - `type: "container_upload"` - `"container_upload"` ### Beta Container Upload Block Param - `BetaContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `file_id: string` - `type: "container_upload"` - `"container_upload"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` ### Beta Content Block - `BetaContentBlock = BetaTextBlock | BetaThinkingBlock | BetaRedactedThinkingBlock | 14 more` Response model for a file uploaded to the container. - `BetaTextBlock` - `citations: Array | null` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `BetaCitationCharLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `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: number` - `document_title: string | null` - `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 | null` - `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` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `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: 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 | null` - `type: "search_result_location"` - `"search_result_location"` - `text: string` - `type: "text"` - `"text"` - `BetaThinkingBlock` - `signature: string` - `thinking: string` - `type: "thinking"` - `"thinking"` - `BetaRedactedThinkingBlock` - `data: string` - `type: "redacted_thinking"` - `"redacted_thinking"` - `BetaToolUseBlock` - `id: string` - `input: Record` - `name: string` - `type: "tool_use"` - `"tool_use"` - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `type: "direct"` - `"direct"` - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `BetaServerToolCaller20260120` - `tool_id: string` - `type: "code_execution_20260120"` - `"code_execution_20260120"` - `BetaServerToolUseBlock` - `id: string` - `input: Record` - `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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebSearchToolResultBlock` - `content: BetaWebSearchToolResultBlockContent` - `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"` - `Array` - `encrypted_content: string` - `page_age: string | null` - `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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebFetchToolResultBlock` - `content: BetaWebFetchToolResultErrorBlock | BetaWebFetchBlock` - `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"` - `BetaWebFetchBlock` - `content: BetaDocumentBlock` - `citations: BetaCitationConfig | null` Citation configuration for the document - `enabled: boolean` - `source: BetaBase64PDFSource | BetaPlainTextSource` - `BetaBase64PDFSource` - `data: string` - `media_type: "application/pdf"` - `"application/pdf"` - `type: "base64"` - `"base64"` - `BetaPlainTextSource` - `data: string` - `media_type: "text/plain"` - `"text/plain"` - `type: "text"` - `"text"` - `title: string | null` The title of the document - `type: "document"` - `"document"` - `retrieved_at: string | null` 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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaAdvisorToolResultBlock` - `content: BetaAdvisorToolResultError | BetaAdvisorResultBlock | BetaAdvisorRedactedResultBlock` - `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"` - `BetaAdvisorResultBlock` - `stop_reason: string | null` 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"` - `BetaAdvisorRedactedResultBlock` - `encrypted_content: string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `stop_reason: string | null` 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"` - `BetaCodeExecutionToolResultBlock` - `content: BetaCodeExecutionToolResultBlockContent` Code execution result with encrypted stdout for PFC + web_search results. - `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"` - `BetaCodeExecutionResultBlock` - `content: Array` - `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` Code execution result with encrypted stdout for PFC + web_search results. - `content: Array` - `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` - `content: BetaBashCodeExecutionToolResultError | BetaBashCodeExecutionResultBlock` - `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"` - `BetaBashCodeExecutionResultBlock` - `content: Array` - `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` - `content: BetaTextEditorCodeExecutionToolResultError | BetaTextEditorCodeExecutionViewResultBlock | BetaTextEditorCodeExecutionCreateResultBlock | BetaTextEditorCodeExecutionStrReplaceResultBlock` - `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 | null` - `type: "text_editor_code_execution_tool_result_error"` - `"text_editor_code_execution_tool_result_error"` - `BetaTextEditorCodeExecutionViewResultBlock` - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number | null` - `start_line: number | null` - `total_lines: number | null` - `type: "text_editor_code_execution_view_result"` - `"text_editor_code_execution_view_result"` - `BetaTextEditorCodeExecutionCreateResultBlock` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `"text_editor_code_execution_create_result"` - `BetaTextEditorCodeExecutionStrReplaceResultBlock` - `lines: Array | null` - `new_lines: number | null` - `new_start: number | null` - `old_lines: number | null` - `old_start: number | null` - `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` - `content: BetaToolSearchToolResultError | BetaToolSearchToolSearchResultBlock` - `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 | null` - `type: "tool_search_tool_result_error"` - `"tool_search_tool_result_error"` - `BetaToolSearchToolSearchResultBlock` - `tool_references: Array` - `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` - `id: string` - `input: Record` - `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` - `content: string | Array` - `string` - `Array` - `citations: Array | null` 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` Response model for a file uploaded to the container. - `file_id: string` - `type: "container_upload"` - `"container_upload"` - `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 | null` Summary of compacted content, or null if compaction failed - `encrypted_content: string | null` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction"` - `"compaction"` - `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. - `"claude-fable-5" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` - `to: BetaFallbackInfo` The fallback model producing the content that follows this block. Its `model` is always the canonical id. - `type: "fallback"` - `"fallback"` ### Beta Content Block Param - `BetaContentBlockParam = BetaTextBlockParam | BetaImageBlockParam | BetaRequestDocumentBlock | 19 more` Regular text content. - `BetaTextBlockParam` - `text: string` - `type: "text"` - `"text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `citations?: Array | null` - `BetaCitationCharLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `BetaCitationContentBlockLocationParam` - `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 | null` - `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`. - `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"` - `BetaCitationWebSearchResultLocationParam` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `BetaCitationSearchResultLocationParam` - `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 | null` - `type: "search_result_location"` - `"search_result_location"` - `BetaImageBlockParam` - `source: BetaBase64ImageSource | BetaURLImageSource | BetaFileImageSource` - `BetaBase64ImageSource` - `data: string` - `media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `type: "base64"` - `"base64"` - `BetaURLImageSource` - `type: "url"` - `"url"` - `url: string` - `BetaFileImageSource` - `file_id: string` - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaRequestDocumentBlock` - `source: BetaBase64PDFSource | BetaPlainTextSource | BetaContentBlockSource | 2 more` - `BetaBase64PDFSource` - `data: string` - `media_type: "application/pdf"` - `"application/pdf"` - `type: "base64"` - `"base64"` - `BetaPlainTextSource` - `data: string` - `media_type: "text/plain"` - `"text/plain"` - `type: "text"` - `"text"` - `BetaContentBlockSource` - `content: string | Array` - `string` - `Array` - `BetaTextBlockParam` - `BetaImageBlockParam` - `type: "content"` - `"content"` - `BetaURLPDFSource` - `type: "url"` - `"url"` - `url: string` - `BetaFileDocumentSource` - `file_id: string` - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam | null` - `enabled?: boolean` - `context?: string | null` - `title?: string | null` - `BetaSearchResultBlockParam` - `content: Array` - `text: string` - `type: "text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `source: string` - `title: string` - `type: "search_result"` - `"search_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam` - `BetaThinkingBlockParam` - `signature: string` - `thinking: string` - `type: "thinking"` - `"thinking"` - `BetaRedactedThinkingBlockParam` - `data: string` - `type: "redacted_thinking"` - `"redacted_thinking"` - `BetaToolUseBlockParam` - `id: string` - `input: Record` - `name: string` - `type: "tool_use"` - `"tool_use"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `type: "direct"` - `"direct"` - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `BetaServerToolCaller20260120` - `tool_id: string` - `type: "code_execution_20260120"` - `"code_execution_20260120"` - `BetaToolResultBlockParam` - `tool_use_id: string` - `type: "tool_result"` - `"tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `content?: string | Array` - `string` - `Array` - `BetaTextBlockParam` - `BetaImageBlockParam` - `BetaSearchResultBlockParam` - `BetaRequestDocumentBlock` - `BetaToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `tool_name: string` - `type: "tool_reference"` - `"tool_reference"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `is_error?: boolean` - `BetaServerToolUseBlockParam` - `id: string` - `input: Record` - `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"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebSearchToolResultBlockParam` - `content: BetaWebSearchToolResultBlockParamContent` - `Array` - `encrypted_content: string` - `title: string` - `type: "web_search_result"` - `"web_search_result"` - `url: string` - `page_age?: string | null` - `BetaWebSearchToolRequestError` - `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"` - `tool_use_id: string` - `type: "web_search_tool_result"` - `"web_search_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebFetchToolResultBlockParam` - `content: BetaWebFetchToolResultErrorBlockParam | BetaWebFetchBlockParam` - `BetaWebFetchToolResultErrorBlockParam` - `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"` - `BetaWebFetchBlockParam` - `content: BetaRequestDocumentBlock` - `type: "web_fetch_result"` - `"web_fetch_result"` - `url: string` Fetched content URL - `retrieved_at?: string | null` ISO 8601 timestamp when the content was retrieved - `tool_use_id: string` - `type: "web_fetch_tool_result"` - `"web_fetch_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaAdvisorToolResultBlockParam` - `content: BetaAdvisorToolResultErrorParam | BetaAdvisorResultBlockParam | BetaAdvisorRedactedResultBlockParam` - `BetaAdvisorToolResultErrorParam` - `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"` - `BetaAdvisorResultBlockParam` - `text: string` - `type: "advisor_result"` - `"advisor_result"` - `stop_reason?: string | null` - `BetaAdvisorRedactedResultBlockParam` - `encrypted_content: string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `type: "advisor_redacted_result"` - `"advisor_redacted_result"` - `stop_reason?: string | null` - `tool_use_id: string` - `type: "advisor_tool_result"` - `"advisor_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaCodeExecutionToolResultBlockParam` - `content: BetaCodeExecutionToolResultBlockParamContent` Code execution result with encrypted stdout for PFC + web_search results. - `BetaCodeExecutionToolResultErrorParam` - `error_code: BetaCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `type: "code_execution_tool_result_error"` - `"code_execution_tool_result_error"` - `BetaCodeExecutionResultBlockParam` - `content: Array` - `file_id: string` - `type: "code_execution_output"` - `"code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "code_execution_result"` - `"code_execution_result"` - `BetaEncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `content: Array` - `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"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaBashCodeExecutionToolResultBlockParam` - `content: BetaBashCodeExecutionToolResultErrorParam | BetaBashCodeExecutionResultBlockParam` - `BetaBashCodeExecutionToolResultErrorParam` - `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"` - `BetaBashCodeExecutionResultBlockParam` - `content: Array` - `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"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaTextEditorCodeExecutionToolResultBlockParam` - `content: BetaTextEditorCodeExecutionToolResultErrorParam | BetaTextEditorCodeExecutionViewResultBlockParam | BetaTextEditorCodeExecutionCreateResultBlockParam | BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `BetaTextEditorCodeExecutionToolResultErrorParam` - `error_code: "invalid_tool_input" | "unavailable" | "too_many_requests" | 2 more` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `type: "text_editor_code_execution_tool_result_error"` - `"text_editor_code_execution_tool_result_error"` - `error_message?: string | null` - `BetaTextEditorCodeExecutionViewResultBlockParam` - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `type: "text_editor_code_execution_view_result"` - `"text_editor_code_execution_view_result"` - `num_lines?: number | null` - `start_line?: number | null` - `total_lines?: number | null` - `BetaTextEditorCodeExecutionCreateResultBlockParam` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `"text_editor_code_execution_create_result"` - `BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `type: "text_editor_code_execution_str_replace_result"` - `"text_editor_code_execution_str_replace_result"` - `lines?: Array | null` - `new_lines?: number | null` - `new_start?: number | null` - `old_lines?: number | null` - `old_start?: number | null` - `tool_use_id: string` - `type: "text_editor_code_execution_tool_result"` - `"text_editor_code_execution_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaToolSearchToolResultBlockParam` - `content: BetaToolSearchToolResultErrorParam | BetaToolSearchToolSearchResultBlockParam` - `BetaToolSearchToolResultErrorParam` - `error_code: "invalid_tool_input" | "unavailable" | "too_many_requests" | "execution_time_exceeded"` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `type: "tool_search_tool_result_error"` - `"tool_search_tool_result_error"` - `error_message?: string | null` - `BetaToolSearchToolSearchResultBlockParam` - `tool_references: Array` - `tool_name: string` - `type: "tool_reference"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "tool_search_tool_search_result"` - `"tool_search_tool_search_result"` - `tool_use_id: string` - `type: "tool_search_tool_result"` - `"tool_search_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaMCPToolUseBlockParam` - `id: string` - `input: Record` - `name: string` - `server_name: string` The name of the MCP server - `type: "mcp_tool_use"` - `"mcp_tool_use"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaRequestMCPToolResultBlockParam` - `tool_use_id: string` - `type: "mcp_tool_result"` - `"mcp_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `content?: string | Array` - `string` - `Array` - `text: string` - `type: "text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `is_error?: boolean` - `BetaContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `file_id: string` - `type: "container_upload"` - `"container_upload"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaCompactionBlockParam` A compaction block containing summary of previous context. Users should round-trip these blocks from responses to subsequent requests to maintain context across compaction boundaries. When content is None, the block represents a failed compaction. The server treats these as no-ops. Empty string content is not allowed. - `type: "compaction"` - `"compaction"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `content?: string | null` Summary of previously compacted content, or null if compaction failed - `encrypted_content?: string | null` Opaque metadata from prior compaction, to be round-tripped verbatim - `BetaMidConversationSystemBlockParam` System instructions that appear mid-conversation. Use this block to provide or update system-level instructions at a specific point in the conversation, rather than only via the top-level `system` parameter. - `content: Array` System instruction text blocks. - `text: string` - `type: "text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `type: "mid_conv_system"` - `"mid_conv_system"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaFallbackBlockParam` A `fallback` block echoed back from a prior response. Accepted in `messages[].content` and never rendered into the prompt, not validated against the request's `fallbacks` chain or top-level `model`, and stripped before the sticky-routing cache key is computed. Callers should echo the assistant turn verbatim — block included. The block's position is load-bearing for thinking verification: the thinking runs on either side of a fallback hop carry independently-rooted verification hash chains, and this block is the only record of where one chain ends and the next begins. When thinking runs flank the boundary, omitting the block merges the runs into one contiguous span whose hashes cannot verify (the request is rejected), and moving it into the middle of a single run splits that run's chain and is likewise rejected; between non-thinking blocks the block's placement has no verification effect. - `from: BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `model: Model` 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" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` - `to: BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `type: "fallback"` - `"fallback"` ### Beta Content Block Source - `BetaContentBlockSource` - `content: string | Array` - `string` - `Array` - `BetaTextBlockParam` - `text: string` - `type: "text"` - `"text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `citations?: Array | null` - `BetaCitationCharLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `BetaCitationContentBlockLocationParam` - `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 | null` - `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`. - `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"` - `BetaCitationWebSearchResultLocationParam` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `BetaCitationSearchResultLocationParam` - `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 | null` - `type: "search_result_location"` - `"search_result_location"` - `BetaImageBlockParam` - `source: BetaBase64ImageSource | BetaURLImageSource | BetaFileImageSource` - `BetaBase64ImageSource` - `data: string` - `media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `type: "base64"` - `"base64"` - `BetaURLImageSource` - `type: "url"` - `"url"` - `url: string` - `BetaFileImageSource` - `file_id: string` - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "content"` - `"content"` ### Beta Content Block Source Content - `BetaContentBlockSourceContent = BetaTextBlockParam | BetaImageBlockParam` - `BetaTextBlockParam` - `text: string` - `type: "text"` - `"text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `citations?: Array | null` - `BetaCitationCharLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `BetaCitationContentBlockLocationParam` - `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 | null` - `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`. - `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"` - `BetaCitationWebSearchResultLocationParam` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `BetaCitationSearchResultLocationParam` - `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 | null` - `type: "search_result_location"` - `"search_result_location"` - `BetaImageBlockParam` - `source: BetaBase64ImageSource | BetaURLImageSource | BetaFileImageSource` - `BetaBase64ImageSource` - `data: string` - `media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `type: "base64"` - `"base64"` - `BetaURLImageSource` - `type: "url"` - `"url"` - `url: string` - `BetaFileImageSource` - `file_id: string` - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. ### Beta Context Management Config - `BetaContextManagementConfig` - `edits?: Array` List of context management edits to apply - `BetaClearToolUses20250919Edit` - `type: "clear_tool_uses_20250919"` - `"clear_tool_uses_20250919"` - `clear_at_least?: BetaInputTokensClearAtLeast | null` Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed. - `type: "input_tokens"` - `"input_tokens"` - `value: number` - `clear_tool_inputs?: boolean | Array | null` Whether to clear all tool inputs (bool) or specific tool inputs to clear (list) - `boolean` - `Array` - `exclude_tools?: Array | null` Tool names whose uses are preserved from clearing - `keep?: BetaToolUsesKeep` Number of tool uses to retain in the conversation - `type: "tool_uses"` - `"tool_uses"` - `value: number` - `trigger?: BetaInputTokensTrigger | BetaToolUsesTrigger` Condition that triggers the context management strategy - `BetaInputTokensTrigger` - `type: "input_tokens"` - `"input_tokens"` - `value: number` - `BetaToolUsesTrigger` - `type: "tool_uses"` - `"tool_uses"` - `value: number` - `BetaClearThinking20251015Edit` - `type: "clear_thinking_20251015"` - `"clear_thinking_20251015"` - `keep?: BetaThinkingTurns | BetaAllThinkingTurns | "all"` Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed. - `BetaThinkingTurns` - `type: "thinking_turns"` - `"thinking_turns"` - `value: number` - `BetaAllThinkingTurns` - `type: "all"` - `"all"` - `"all"` - `"all"` - `BetaCompact20260112Edit` Automatically compact older context when reaching the configured trigger threshold. - `type: "compact_20260112"` - `"compact_20260112"` - `instructions?: string | null` Additional instructions for summarization. - `pause_after_compaction?: boolean` Whether to pause after compaction and return the compaction block to the user. - `trigger?: BetaInputTokensTrigger | null` When to trigger compaction. Defaults to 150000 input tokens. ### Beta Context Management Response - `BetaContextManagementResponse` - `applied_edits: Array` List of context management edits that were applied. - `BetaClearToolUses20250919EditResponse` - `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` - `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"` ### Beta Count Tokens Context Management Response - `BetaCountTokensContextManagementResponse` - `original_input_tokens: number` The original token count before context management was applied ### Beta 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 | null` 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` - `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` - `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` - `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` - `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` - `type: "previous_message_not_found"` - `"previous_message_not_found"` - `BetaCacheMissUnavailable` - `type: "unavailable"` - `"unavailable"` ### Beta Diagnostics Param - `BetaDiagnosticsParam` Request-level diagnostics. Currently carries the previous response id for prompt-cache divergence reporting. - `previous_message_id?: string | null` The `id` (`msg_...`) from this client's previous /v1/messages response. The server compares that request's prompt fingerprint against this one and returns `diagnostics.cache_miss_reason` when the prompt-cache prefix could not be reused. Pass `null` on the first turn to opt in without a prior message to compare. ### Beta Direct Caller - `BetaDirectCaller` Tool invocation directly from the model. - `type: "direct"` - `"direct"` ### Beta Document Block - `BetaDocumentBlock` - `citations: BetaCitationConfig | null` Citation configuration for the document - `enabled: boolean` - `source: BetaBase64PDFSource | BetaPlainTextSource` - `BetaBase64PDFSource` - `data: string` - `media_type: "application/pdf"` - `"application/pdf"` - `type: "base64"` - `"base64"` - `BetaPlainTextSource` - `data: string` - `media_type: "text/plain"` - `"text/plain"` - `type: "text"` - `"text"` - `title: string | null` The title of the document - `type: "document"` - `"document"` ### Beta Encrypted Code Execution Result Block - `BetaEncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `content: Array` - `file_id: string` - `type: "code_execution_output"` - `"code_execution_output"` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `type: "encrypted_code_execution_result"` - `"encrypted_code_execution_result"` ### Beta Encrypted Code Execution Result Block Param - `BetaEncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `content: Array` - `file_id: string` - `type: "code_execution_output"` - `"code_execution_output"` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `type: "encrypted_code_execution_result"` - `"encrypted_code_execution_result"` ### Beta Fallback Block - `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. - `"claude-fable-5" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` - `to: BetaFallbackInfo` The fallback model producing the content that follows this block. Its `model` is always the canonical id. - `type: "fallback"` - `"fallback"` ### Beta Fallback Block Param - `BetaFallbackBlockParam` A `fallback` block echoed back from a prior response. Accepted in `messages[].content` and never rendered into the prompt, not validated against the request's `fallbacks` chain or top-level `model`, and stripped before the sticky-routing cache key is computed. Callers should echo the assistant turn verbatim — block included. The block's position is load-bearing for thinking verification: the thinking runs on either side of a fallback hop carry independently-rooted verification hash chains, and this block is the only record of where one chain ends and the next begins. When thinking runs flank the boundary, omitting the block merges the runs into one contiguous span whose hashes cannot verify (the request is rejected), and moving it into the middle of a single run splits that run's chain and is likewise rejected; between non-thinking blocks the block's placement has no verification effect. - `from: BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `model: Model` 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" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` - `to: BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `type: "fallback"` - `"fallback"` ### Beta Fallback Info - `BetaFallbackInfo` Identifies one hop of a fallback transition. - `model: Model` 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" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` ### Beta Fallback Info Param - `BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `model: Model` 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" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` ### Beta Fallback Message Iteration Usage - `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 | null` 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. - `input_tokens: number` 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. - `"claude-fable-5" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` - `output_tokens: number` The number of output tokens which were used. - `type: "fallback_message"` Usage for the fallback-model attempt that served the response - `"fallback_message"` ### Beta Fallback Param - `BetaFallbackParam` One entry in the `fallbacks` chain on a `/v1/messages` request. `model` is required. The four override fields (`max_tokens`, `thinking`, `output_config`, and `speed`) replace the corresponding top-level field for this attempt only and are validated as if the request were made to `model`. Any other key is rejected at parse time. - `model: Model` 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" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` - `max_tokens?: number | null` - `output_config?: BetaOutputConfig | null` - `effort?: "low" | "medium" | "high" | 2 more | null` All possible effort levels. - `"low"` - `"medium"` - `"high"` - `"xhigh"` - `"max"` - `format?: BetaJSONOutputFormat | null` A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) - `schema: Record` The JSON schema of the format - `type: "json_schema"` - `"json_schema"` - `task_budget?: BetaTokenTaskBudget | null` User-configurable total token budget across contexts. - `total: number` Total token budget across all contexts in the session. - `type: "tokens"` The budget type. Currently only 'tokens' is supported. - `"tokens"` - `remaining?: number | null` Remaining tokens in the budget. Use this to track usage across contexts when implementing compaction client-side. Defaults to total if not provided. - `speed?: "standard" | "fast" | null` - `"standard"` - `"fast"` - `thinking?: BetaThinkingConfigEnabled | BetaThinkingConfigDisabled | BetaThinkingConfigAdaptive | null` - `BetaThinkingConfigEnabled` - `budget_tokens: number` Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality. Must be ≥1024 and less than `max_tokens`. See [extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details. - `type: "enabled"` - `"enabled"` - `display?: "summarized" | "omitted" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. - `"summarized"` - `"omitted"` - `BetaThinkingConfigDisabled` - `type: "disabled"` - `"disabled"` - `BetaThinkingConfigAdaptive` - `type: "adaptive"` - `"adaptive"` - `display?: "summarized" | "omitted" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. - `"summarized"` - `"omitted"` ### Beta File Document Source - `BetaFileDocumentSource` - `file_id: string` - `type: "file"` - `"file"` ### Beta File Image Source - `BetaFileImageSource` - `file_id: string` - `type: "file"` - `"file"` ### Beta Image Block Param - `BetaImageBlockParam` - `source: BetaBase64ImageSource | BetaURLImageSource | BetaFileImageSource` - `BetaBase64ImageSource` - `data: string` - `media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `type: "base64"` - `"base64"` - `BetaURLImageSource` - `type: "url"` - `"url"` - `url: string` - `BetaFileImageSource` - `file_id: string` - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` ### Beta Input JSON Delta - `BetaInputJSONDelta` - `partial_json: string` - `type: "input_json_delta"` - `"input_json_delta"` ### Beta Input Tokens Clear At Least - `BetaInputTokensClearAtLeast` - `type: "input_tokens"` - `"input_tokens"` - `value: number` ### Beta Input Tokens Trigger - `BetaInputTokensTrigger` - `type: "input_tokens"` - `"input_tokens"` - `value: number` ### Beta Iterations Usage - `BetaIterationsUsage = Array | null` 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` Token usage for a sampling iteration. - `cache_creation: BetaCacheCreation | null` 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. - `input_tokens: number` 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. - `"claude-fable-5" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` - `output_tokens: number` The number of output tokens which were used. - `type: "message"` Usage for a sampling iteration - `"message"` - `BetaCompactionIterationUsage` Token usage for a compaction iteration. - `cache_creation: BetaCacheCreation | null` 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` Token usage for an advisor sub-inference iteration. - `cache_creation: BetaCacheCreation | null` 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](https://docs.anthropic.com/en/docs/models-overview) 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"` - `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 | null` 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](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: number` The number of output tokens which were used. - `type: "fallback_message"` Usage for the fallback-model attempt that served the response - `"fallback_message"` ### Beta JSON Output Format - `BetaJSONOutputFormat` - `schema: Record` The JSON schema of the format - `type: "json_schema"` - `"json_schema"` ### Beta MCP Tool Config - `BetaMCPToolConfig` Configuration for a specific tool in an MCP toolset. - `defer_loading?: boolean` - `enabled?: boolean` ### Beta MCP Tool Default Config - `BetaMCPToolDefaultConfig` Default configuration for tools in an MCP toolset. - `defer_loading?: boolean` - `enabled?: boolean` ### Beta MCP Tool Result Block - `BetaMCPToolResultBlock` - `content: string | Array` - `string` - `Array` - `citations: Array | null` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `BetaCitationCharLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `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: number` - `document_title: string | null` - `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 | null` - `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` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `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: 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 | null` - `type: "search_result_location"` - `"search_result_location"` - `text: string` - `type: "text"` - `"text"` - `is_error: boolean` - `tool_use_id: string` - `type: "mcp_tool_result"` - `"mcp_tool_result"` ### Beta MCP Tool Use Block - `BetaMCPToolUseBlock` - `id: string` - `input: Record` - `name: string` The name of the MCP tool - `server_name: string` The name of the MCP server - `type: "mcp_tool_use"` - `"mcp_tool_use"` ### Beta MCP Tool Use Block Param - `BetaMCPToolUseBlockParam` - `id: string` - `input: Record` - `name: string` - `server_name: string` The name of the MCP server - `type: "mcp_tool_use"` - `"mcp_tool_use"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` ### Beta MCP Toolset - `BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `mcp_server_name: string` Name of the MCP server to configure tools for - `type: "mcp_toolset"` - `"mcp_toolset"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `configs?: Record | null` Configuration overrides for specific tools, keyed by tool name - `defer_loading?: boolean` - `enabled?: boolean` - `default_config?: BetaMCPToolDefaultConfig` Default configuration applied to all tools from this server - `defer_loading?: boolean` - `enabled?: boolean` ### Beta Memory Tool 20250818 - `BetaMemoryTool20250818` - `name: "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"memory"` - `type: "memory_20250818"` - `"memory_20250818"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Beta Memory Tool 20250818 Command - `BetaMemoryTool20250818Command = BetaMemoryTool20250818ViewCommand | BetaMemoryTool20250818CreateCommand | BetaMemoryTool20250818StrReplaceCommand | 3 more` - `BetaMemoryTool20250818ViewCommand` - `command: "view"` Command type identifier - `"view"` - `path: string` Path to directory or file to view - `view_range?: Array` Optional line range for viewing specific lines - `BetaMemoryTool20250818CreateCommand` - `command: "create"` Command type identifier - `"create"` - `file_text: string` Content to write to the file - `path: string` Path where the file should be created - `BetaMemoryTool20250818StrReplaceCommand` - `command: "str_replace"` Command type identifier - `"str_replace"` - `new_str: string` Text to replace with - `old_str: string` Text to search for and replace - `path: string` Path to the file where text should be replaced - `BetaMemoryTool20250818InsertCommand` - `command: "insert"` Command type identifier - `"insert"` - `insert_line: number` Line number where text should be inserted - `insert_text: string` Text to insert at the specified line - `path: string` Path to the file where text should be inserted - `BetaMemoryTool20250818DeleteCommand` - `command: "delete"` Command type identifier - `"delete"` - `path: string` Path to the file or directory to delete - `BetaMemoryTool20250818RenameCommand` - `command: "rename"` Command type identifier - `"rename"` - `new_path: string` New path for the file or directory - `old_path: string` Current path of the file or directory ### Beta Memory Tool 20250818 Create Command - `BetaMemoryTool20250818CreateCommand` - `command: "create"` Command type identifier - `"create"` - `file_text: string` Content to write to the file - `path: string` Path where the file should be created ### Beta Memory Tool 20250818 Delete Command - `BetaMemoryTool20250818DeleteCommand` - `command: "delete"` Command type identifier - `"delete"` - `path: string` Path to the file or directory to delete ### Beta Memory Tool 20250818 Insert Command - `BetaMemoryTool20250818InsertCommand` - `command: "insert"` Command type identifier - `"insert"` - `insert_line: number` Line number where text should be inserted - `insert_text: string` Text to insert at the specified line - `path: string` Path to the file where text should be inserted ### Beta Memory Tool 20250818 Rename Command - `BetaMemoryTool20250818RenameCommand` - `command: "rename"` Command type identifier - `"rename"` - `new_path: string` New path for the file or directory - `old_path: string` Current path of the file or directory ### Beta Memory Tool 20250818 Str Replace Command - `BetaMemoryTool20250818StrReplaceCommand` - `command: "str_replace"` Command type identifier - `"str_replace"` - `new_str: string` Text to replace with - `old_str: string` Text to search for and replace - `path: string` Path to the file where text should be replaced ### Beta Memory Tool 20250818 View Command - `BetaMemoryTool20250818ViewCommand` - `command: "view"` Command type identifier - `"view"` - `path: string` Path to directory or file to view - `view_range?: Array` Optional line range for viewing specific lines ### Beta Message - `BetaMessage` - `id: string` Unique object identifier. The format and length of IDs may change over time. - `container: BetaContainer | null` 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 | null` 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` 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)"}] ``` - `BetaTextBlock` - `citations: Array | null` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `BetaCitationCharLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `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: number` - `document_title: string | null` - `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 | null` - `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` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `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: 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 | null` - `type: "search_result_location"` - `"search_result_location"` - `text: string` - `type: "text"` - `"text"` - `BetaThinkingBlock` - `signature: string` - `thinking: string` - `type: "thinking"` - `"thinking"` - `BetaRedactedThinkingBlock` - `data: string` - `type: "redacted_thinking"` - `"redacted_thinking"` - `BetaToolUseBlock` - `id: string` - `input: Record` - `name: string` - `type: "tool_use"` - `"tool_use"` - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `type: "direct"` - `"direct"` - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `BetaServerToolCaller20260120` - `tool_id: string` - `type: "code_execution_20260120"` - `"code_execution_20260120"` - `BetaServerToolUseBlock` - `id: string` - `input: Record` - `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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebSearchToolResultBlock` - `content: BetaWebSearchToolResultBlockContent` - `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"` - `Array` - `encrypted_content: string` - `page_age: string | null` - `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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebFetchToolResultBlock` - `content: BetaWebFetchToolResultErrorBlock | BetaWebFetchBlock` - `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"` - `BetaWebFetchBlock` - `content: BetaDocumentBlock` - `citations: BetaCitationConfig | null` Citation configuration for the document - `enabled: boolean` - `source: BetaBase64PDFSource | BetaPlainTextSource` - `BetaBase64PDFSource` - `data: string` - `media_type: "application/pdf"` - `"application/pdf"` - `type: "base64"` - `"base64"` - `BetaPlainTextSource` - `data: string` - `media_type: "text/plain"` - `"text/plain"` - `type: "text"` - `"text"` - `title: string | null` The title of the document - `type: "document"` - `"document"` - `retrieved_at: string | null` 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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaAdvisorToolResultBlock` - `content: BetaAdvisorToolResultError | BetaAdvisorResultBlock | BetaAdvisorRedactedResultBlock` - `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"` - `BetaAdvisorResultBlock` - `stop_reason: string | null` 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"` - `BetaAdvisorRedactedResultBlock` - `encrypted_content: string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `stop_reason: string | null` 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"` - `BetaCodeExecutionToolResultBlock` - `content: BetaCodeExecutionToolResultBlockContent` Code execution result with encrypted stdout for PFC + web_search results. - `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"` - `BetaCodeExecutionResultBlock` - `content: Array` - `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` Code execution result with encrypted stdout for PFC + web_search results. - `content: Array` - `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` - `content: BetaBashCodeExecutionToolResultError | BetaBashCodeExecutionResultBlock` - `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"` - `BetaBashCodeExecutionResultBlock` - `content: Array` - `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` - `content: BetaTextEditorCodeExecutionToolResultError | BetaTextEditorCodeExecutionViewResultBlock | BetaTextEditorCodeExecutionCreateResultBlock | BetaTextEditorCodeExecutionStrReplaceResultBlock` - `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 | null` - `type: "text_editor_code_execution_tool_result_error"` - `"text_editor_code_execution_tool_result_error"` - `BetaTextEditorCodeExecutionViewResultBlock` - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number | null` - `start_line: number | null` - `total_lines: number | null` - `type: "text_editor_code_execution_view_result"` - `"text_editor_code_execution_view_result"` - `BetaTextEditorCodeExecutionCreateResultBlock` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `"text_editor_code_execution_create_result"` - `BetaTextEditorCodeExecutionStrReplaceResultBlock` - `lines: Array | null` - `new_lines: number | null` - `new_start: number | null` - `old_lines: number | null` - `old_start: number | null` - `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` - `content: BetaToolSearchToolResultError | BetaToolSearchToolSearchResultBlock` - `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 | null` - `type: "tool_search_tool_result_error"` - `"tool_search_tool_result_error"` - `BetaToolSearchToolSearchResultBlock` - `tool_references: Array` - `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` - `id: string` - `input: Record` - `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` - `content: string | Array` - `string` - `Array` - `citations: Array | null` 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` Response model for a file uploaded to the container. - `file_id: string` - `type: "container_upload"` - `"container_upload"` - `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 | null` Summary of compacted content, or null if compaction failed - `encrypted_content: string | null` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction"` - `"compaction"` - `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. - `"claude-fable-5" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` - `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 | null` Context management response. Information about context management strategies applied during the request. - `applied_edits: Array` List of context management edits that were applied. - `BetaClearToolUses20250919EditResponse` - `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` - `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 | null` 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 | null` 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` - `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` - `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` - `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` - `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` - `type: "previous_message_not_found"` - `"previous_message_not_found"` - `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 | null` Structured information about a refusal. - `category: "cyber" | "bio" | "reasoning_extraction" | null` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` - `"bio"` - `"reasoning_extraction"` - `explanation: string | null` 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 | null` 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: boolean | null` 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 | null` 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 | null` 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 | null` 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 | null` 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 | null` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number | null` The number of input tokens read from the cache. - `inference_geo: string | null` The geographic region where inference was performed for this request. - `input_tokens: number` The number of input tokens which were used. - `iterations: BetaIterationsUsage | null` 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` Token usage for a sampling iteration. - `cache_creation: BetaCacheCreation | null` 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](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: number` The number of output tokens which were used. - `type: "message"` Usage for a sampling iteration - `"message"` - `BetaCompactionIterationUsage` Token usage for a compaction iteration. - `cache_creation: BetaCacheCreation | null` 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` Token usage for an advisor sub-inference iteration. - `cache_creation: BetaCacheCreation | null` 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](https://docs.anthropic.com/en/docs/models-overview) 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"` - `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 | null` 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](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: number` 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: number` The number of output tokens which were used. - `output_tokens_details: BetaOutputTokensDetails | null` 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: number` 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 | null` 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" | "priority" | "batch" | null` If the request used the priority, standard, or batch tier. - `"standard"` - `"priority"` - `"batch"` - `speed: "standard" | "fast" | null` The inference speed mode used for this request. - `"standard"` - `"fast"` ### Beta Message Delta Usage - `BetaMessageDeltaUsage` - `cache_creation_input_tokens: number | null` The cumulative number of input tokens used to create the cache entry. - `cache_read_input_tokens: number | null` The cumulative number of input tokens read from the cache. - `input_tokens: number | null` The cumulative number of input tokens which were used. - `iterations: BetaIterationsUsage | null` 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` Token usage for a sampling iteration. - `cache_creation: BetaCacheCreation | null` 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. - `input_tokens: number` 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. - `"claude-fable-5" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` - `output_tokens: number` The number of output tokens which were used. - `type: "message"` Usage for a sampling iteration - `"message"` - `BetaCompactionIterationUsage` Token usage for a compaction iteration. - `cache_creation: BetaCacheCreation | null` 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` Token usage for an advisor sub-inference iteration. - `cache_creation: BetaCacheCreation | null` 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](https://docs.anthropic.com/en/docs/models-overview) 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"` - `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 | null` 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](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: number` 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: number` The cumulative number of output tokens which were used. - `output_tokens_details: BetaOutputTokensDetails | null` 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: number` 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 | null` 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. ### Beta Message Iteration Usage - `BetaMessageIterationUsage` Token usage for a sampling iteration. - `cache_creation: BetaCacheCreation | null` 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. - `input_tokens: number` 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. - `"claude-fable-5" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` - `output_tokens: number` The number of output tokens which were used. - `type: "message"` Usage for a sampling iteration - `"message"` ### Beta Message Param - `BetaMessageParam` - `content: string | Array` - `string` - `Array` - `BetaTextBlockParam` - `text: string` - `type: "text"` - `"text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `citations?: Array | null` - `BetaCitationCharLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `BetaCitationContentBlockLocationParam` - `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 | null` - `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`. - `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"` - `BetaCitationWebSearchResultLocationParam` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `BetaCitationSearchResultLocationParam` - `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 | null` - `type: "search_result_location"` - `"search_result_location"` - `BetaImageBlockParam` - `source: BetaBase64ImageSource | BetaURLImageSource | BetaFileImageSource` - `BetaBase64ImageSource` - `data: string` - `media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `type: "base64"` - `"base64"` - `BetaURLImageSource` - `type: "url"` - `"url"` - `url: string` - `BetaFileImageSource` - `file_id: string` - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaRequestDocumentBlock` - `source: BetaBase64PDFSource | BetaPlainTextSource | BetaContentBlockSource | 2 more` - `BetaBase64PDFSource` - `data: string` - `media_type: "application/pdf"` - `"application/pdf"` - `type: "base64"` - `"base64"` - `BetaPlainTextSource` - `data: string` - `media_type: "text/plain"` - `"text/plain"` - `type: "text"` - `"text"` - `BetaContentBlockSource` - `content: string | Array` - `string` - `Array` - `BetaTextBlockParam` - `BetaImageBlockParam` - `type: "content"` - `"content"` - `BetaURLPDFSource` - `type: "url"` - `"url"` - `url: string` - `BetaFileDocumentSource` - `file_id: string` - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam | null` - `enabled?: boolean` - `context?: string | null` - `title?: string | null` - `BetaSearchResultBlockParam` - `content: Array` - `text: string` - `type: "text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `source: string` - `title: string` - `type: "search_result"` - `"search_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam` - `BetaThinkingBlockParam` - `signature: string` - `thinking: string` - `type: "thinking"` - `"thinking"` - `BetaRedactedThinkingBlockParam` - `data: string` - `type: "redacted_thinking"` - `"redacted_thinking"` - `BetaToolUseBlockParam` - `id: string` - `input: Record` - `name: string` - `type: "tool_use"` - `"tool_use"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `type: "direct"` - `"direct"` - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `BetaServerToolCaller20260120` - `tool_id: string` - `type: "code_execution_20260120"` - `"code_execution_20260120"` - `BetaToolResultBlockParam` - `tool_use_id: string` - `type: "tool_result"` - `"tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `content?: string | Array` - `string` - `Array` - `BetaTextBlockParam` - `BetaImageBlockParam` - `BetaSearchResultBlockParam` - `BetaRequestDocumentBlock` - `BetaToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `tool_name: string` - `type: "tool_reference"` - `"tool_reference"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `is_error?: boolean` - `BetaServerToolUseBlockParam` - `id: string` - `input: Record` - `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"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebSearchToolResultBlockParam` - `content: BetaWebSearchToolResultBlockParamContent` - `Array` - `encrypted_content: string` - `title: string` - `type: "web_search_result"` - `"web_search_result"` - `url: string` - `page_age?: string | null` - `BetaWebSearchToolRequestError` - `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"` - `tool_use_id: string` - `type: "web_search_tool_result"` - `"web_search_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebFetchToolResultBlockParam` - `content: BetaWebFetchToolResultErrorBlockParam | BetaWebFetchBlockParam` - `BetaWebFetchToolResultErrorBlockParam` - `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"` - `BetaWebFetchBlockParam` - `content: BetaRequestDocumentBlock` - `type: "web_fetch_result"` - `"web_fetch_result"` - `url: string` Fetched content URL - `retrieved_at?: string | null` ISO 8601 timestamp when the content was retrieved - `tool_use_id: string` - `type: "web_fetch_tool_result"` - `"web_fetch_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaAdvisorToolResultBlockParam` - `content: BetaAdvisorToolResultErrorParam | BetaAdvisorResultBlockParam | BetaAdvisorRedactedResultBlockParam` - `BetaAdvisorToolResultErrorParam` - `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"` - `BetaAdvisorResultBlockParam` - `text: string` - `type: "advisor_result"` - `"advisor_result"` - `stop_reason?: string | null` - `BetaAdvisorRedactedResultBlockParam` - `encrypted_content: string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `type: "advisor_redacted_result"` - `"advisor_redacted_result"` - `stop_reason?: string | null` - `tool_use_id: string` - `type: "advisor_tool_result"` - `"advisor_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaCodeExecutionToolResultBlockParam` - `content: BetaCodeExecutionToolResultBlockParamContent` Code execution result with encrypted stdout for PFC + web_search results. - `BetaCodeExecutionToolResultErrorParam` - `error_code: BetaCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `type: "code_execution_tool_result_error"` - `"code_execution_tool_result_error"` - `BetaCodeExecutionResultBlockParam` - `content: Array` - `file_id: string` - `type: "code_execution_output"` - `"code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "code_execution_result"` - `"code_execution_result"` - `BetaEncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `content: Array` - `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"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaBashCodeExecutionToolResultBlockParam` - `content: BetaBashCodeExecutionToolResultErrorParam | BetaBashCodeExecutionResultBlockParam` - `BetaBashCodeExecutionToolResultErrorParam` - `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"` - `BetaBashCodeExecutionResultBlockParam` - `content: Array` - `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"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaTextEditorCodeExecutionToolResultBlockParam` - `content: BetaTextEditorCodeExecutionToolResultErrorParam | BetaTextEditorCodeExecutionViewResultBlockParam | BetaTextEditorCodeExecutionCreateResultBlockParam | BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `BetaTextEditorCodeExecutionToolResultErrorParam` - `error_code: "invalid_tool_input" | "unavailable" | "too_many_requests" | 2 more` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `type: "text_editor_code_execution_tool_result_error"` - `"text_editor_code_execution_tool_result_error"` - `error_message?: string | null` - `BetaTextEditorCodeExecutionViewResultBlockParam` - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `type: "text_editor_code_execution_view_result"` - `"text_editor_code_execution_view_result"` - `num_lines?: number | null` - `start_line?: number | null` - `total_lines?: number | null` - `BetaTextEditorCodeExecutionCreateResultBlockParam` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `"text_editor_code_execution_create_result"` - `BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `type: "text_editor_code_execution_str_replace_result"` - `"text_editor_code_execution_str_replace_result"` - `lines?: Array | null` - `new_lines?: number | null` - `new_start?: number | null` - `old_lines?: number | null` - `old_start?: number | null` - `tool_use_id: string` - `type: "text_editor_code_execution_tool_result"` - `"text_editor_code_execution_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaToolSearchToolResultBlockParam` - `content: BetaToolSearchToolResultErrorParam | BetaToolSearchToolSearchResultBlockParam` - `BetaToolSearchToolResultErrorParam` - `error_code: "invalid_tool_input" | "unavailable" | "too_many_requests" | "execution_time_exceeded"` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `type: "tool_search_tool_result_error"` - `"tool_search_tool_result_error"` - `error_message?: string | null` - `BetaToolSearchToolSearchResultBlockParam` - `tool_references: Array` - `tool_name: string` - `type: "tool_reference"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "tool_search_tool_search_result"` - `"tool_search_tool_search_result"` - `tool_use_id: string` - `type: "tool_search_tool_result"` - `"tool_search_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaMCPToolUseBlockParam` - `id: string` - `input: Record` - `name: string` - `server_name: string` The name of the MCP server - `type: "mcp_tool_use"` - `"mcp_tool_use"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaRequestMCPToolResultBlockParam` - `tool_use_id: string` - `type: "mcp_tool_result"` - `"mcp_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `content?: string | Array` - `string` - `Array` - `text: string` - `type: "text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `is_error?: boolean` - `BetaContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `file_id: string` - `type: "container_upload"` - `"container_upload"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaCompactionBlockParam` A compaction block containing summary of previous context. Users should round-trip these blocks from responses to subsequent requests to maintain context across compaction boundaries. When content is None, the block represents a failed compaction. The server treats these as no-ops. Empty string content is not allowed. - `type: "compaction"` - `"compaction"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `content?: string | null` Summary of previously compacted content, or null if compaction failed - `encrypted_content?: string | null` Opaque metadata from prior compaction, to be round-tripped verbatim - `BetaMidConversationSystemBlockParam` System instructions that appear mid-conversation. Use this block to provide or update system-level instructions at a specific point in the conversation, rather than only via the top-level `system` parameter. - `content: Array` System instruction text blocks. - `text: string` - `type: "text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `type: "mid_conv_system"` - `"mid_conv_system"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaFallbackBlockParam` A `fallback` block echoed back from a prior response. Accepted in `messages[].content` and never rendered into the prompt, not validated against the request's `fallbacks` chain or top-level `model`, and stripped before the sticky-routing cache key is computed. Callers should echo the assistant turn verbatim — block included. The block's position is load-bearing for thinking verification: the thinking runs on either side of a fallback hop carry independently-rooted verification hash chains, and this block is the only record of where one chain ends and the next begins. When thinking runs flank the boundary, omitting the block merges the runs into one contiguous span whose hashes cannot verify (the request is rejected), and moving it into the middle of a single run splits that run's chain and is likewise rejected; between non-thinking blocks the block's placement has no verification effect. - `from: BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `model: Model` 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" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` - `to: BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `type: "fallback"` - `"fallback"` - `role: "user" | "assistant" | "system"` - `"user"` - `"assistant"` - `"system"` ### Beta Message Tokens Count - `BetaMessageTokensCount` - `context_management: BetaCountTokensContextManagementResponse | null` Information about context management applied to the message. - `original_input_tokens: number` The original token count before context management was applied - `input_tokens: number` The total number of tokens across the provided list of messages, system prompt, and tools. ### Beta Metadata - `BetaMetadata` - `user_id?: string | null` An external identifier for the user who is associated with the request. This should be a uuid, hash value, or other opaque identifier. Anthropic may use this id to help detect abuse. Do not include any identifying information such as name, email address, or phone number. ### Beta Mid Conversation System Block Param - `BetaMidConversationSystemBlockParam` System instructions that appear mid-conversation. Use this block to provide or update system-level instructions at a specific point in the conversation, rather than only via the top-level `system` parameter. - `content: Array` System instruction text blocks. - `text: string` - `type: "text"` - `"text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `citations?: Array | null` - `BetaCitationCharLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `BetaCitationContentBlockLocationParam` - `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 | null` - `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`. - `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"` - `BetaCitationWebSearchResultLocationParam` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `BetaCitationSearchResultLocationParam` - `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 | null` - `type: "search_result_location"` - `"search_result_location"` - `type: "mid_conv_system"` - `"mid_conv_system"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. ### Beta Output Config - `BetaOutputConfig` - `effort?: "low" | "medium" | "high" | 2 more | null` All possible effort levels. - `"low"` - `"medium"` - `"high"` - `"xhigh"` - `"max"` - `format?: BetaJSONOutputFormat | null` A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) - `schema: Record` The JSON schema of the format - `type: "json_schema"` - `"json_schema"` - `task_budget?: BetaTokenTaskBudget | null` User-configurable total token budget across contexts. - `total: number` Total token budget across all contexts in the session. - `type: "tokens"` The budget type. Currently only 'tokens' is supported. - `"tokens"` - `remaining?: number | null` Remaining tokens in the budget. Use this to track usage across contexts when implementing compaction client-side. Defaults to total if not provided. ### Beta Output Tokens Details - `BetaOutputTokensDetails` - `thinking_tokens: number` 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. ### Beta Plain Text Source - `BetaPlainTextSource` - `data: string` - `media_type: "text/plain"` - `"text/plain"` - `type: "text"` - `"text"` ### Beta Raw Content Block Delta - `BetaRawContentBlockDelta = BetaTextDelta | BetaInputJSONDelta | BetaCitationsDelta | 3 more` - `BetaTextDelta` - `text: string` - `type: "text_delta"` - `"text_delta"` - `BetaInputJSONDelta` - `partial_json: string` - `type: "input_json_delta"` - `"input_json_delta"` - `BetaCitationsDelta` - `citation: BetaCitationCharLocation | BetaCitationPageLocation | BetaCitationContentBlockLocation | 2 more` - `BetaCitationCharLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `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: number` - `document_title: string | null` - `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 | null` - `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` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `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: 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 | null` - `type: "search_result_location"` - `"search_result_location"` - `type: "citations_delta"` - `"citations_delta"` - `BetaThinkingDelta` - `estimated_tokens: number | null` Per-frame increment of a coarse, running estimate of the tokens this thinking block has produced so far. Present whenever the `thinking-token-count-2026-05-13` beta is set; `null` unless `thinking.display` resolves to `"omitted"` and a count is due this frame. Sum the increments across `thinking_delta` frames on this block for a progress indicator. Each increment is a non-negative multiple of a fixed quantum and the cadence is rate-limited, so this is a deliberately lossy display hint, not a billable count; `usage.output_tokens` remains authoritative. - `thinking: string` - `type: "thinking_delta"` - `"thinking_delta"` - `BetaSignatureDelta` - `signature: string` - `type: "signature_delta"` - `"signature_delta"` - `BetaCompactionContentBlockDelta` - `content: string | null` - `encrypted_content: string | null` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction_delta"` - `"compaction_delta"` ### Beta Raw Content Block Delta Event - `BetaRawContentBlockDeltaEvent` - `delta: BetaRawContentBlockDelta` - `BetaTextDelta` - `text: string` - `type: "text_delta"` - `"text_delta"` - `BetaInputJSONDelta` - `partial_json: string` - `type: "input_json_delta"` - `"input_json_delta"` - `BetaCitationsDelta` - `citation: BetaCitationCharLocation | BetaCitationPageLocation | BetaCitationContentBlockLocation | 2 more` - `BetaCitationCharLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `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: number` - `document_title: string | null` - `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 | null` - `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` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `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: 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 | null` - `type: "search_result_location"` - `"search_result_location"` - `type: "citations_delta"` - `"citations_delta"` - `BetaThinkingDelta` - `estimated_tokens: number | null` Per-frame increment of a coarse, running estimate of the tokens this thinking block has produced so far. Present whenever the `thinking-token-count-2026-05-13` beta is set; `null` unless `thinking.display` resolves to `"omitted"` and a count is due this frame. Sum the increments across `thinking_delta` frames on this block for a progress indicator. Each increment is a non-negative multiple of a fixed quantum and the cadence is rate-limited, so this is a deliberately lossy display hint, not a billable count; `usage.output_tokens` remains authoritative. - `thinking: string` - `type: "thinking_delta"` - `"thinking_delta"` - `BetaSignatureDelta` - `signature: string` - `type: "signature_delta"` - `"signature_delta"` - `BetaCompactionContentBlockDelta` - `content: string | null` - `encrypted_content: string | null` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction_delta"` - `"compaction_delta"` - `index: number` - `type: "content_block_delta"` - `"content_block_delta"` ### Beta Raw Content Block Start Event - `BetaRawContentBlockStartEvent` - `content_block: BetaTextBlock | BetaThinkingBlock | BetaRedactedThinkingBlock | 14 more` Response model for a file uploaded to the container. - `BetaTextBlock` - `citations: Array | null` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `BetaCitationCharLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `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: number` - `document_title: string | null` - `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 | null` - `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` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `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: 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 | null` - `type: "search_result_location"` - `"search_result_location"` - `text: string` - `type: "text"` - `"text"` - `BetaThinkingBlock` - `signature: string` - `thinking: string` - `type: "thinking"` - `"thinking"` - `BetaRedactedThinkingBlock` - `data: string` - `type: "redacted_thinking"` - `"redacted_thinking"` - `BetaToolUseBlock` - `id: string` - `input: Record` - `name: string` - `type: "tool_use"` - `"tool_use"` - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `type: "direct"` - `"direct"` - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `BetaServerToolCaller20260120` - `tool_id: string` - `type: "code_execution_20260120"` - `"code_execution_20260120"` - `BetaServerToolUseBlock` - `id: string` - `input: Record` - `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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebSearchToolResultBlock` - `content: BetaWebSearchToolResultBlockContent` - `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"` - `Array` - `encrypted_content: string` - `page_age: string | null` - `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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebFetchToolResultBlock` - `content: BetaWebFetchToolResultErrorBlock | BetaWebFetchBlock` - `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"` - `BetaWebFetchBlock` - `content: BetaDocumentBlock` - `citations: BetaCitationConfig | null` Citation configuration for the document - `enabled: boolean` - `source: BetaBase64PDFSource | BetaPlainTextSource` - `BetaBase64PDFSource` - `data: string` - `media_type: "application/pdf"` - `"application/pdf"` - `type: "base64"` - `"base64"` - `BetaPlainTextSource` - `data: string` - `media_type: "text/plain"` - `"text/plain"` - `type: "text"` - `"text"` - `title: string | null` The title of the document - `type: "document"` - `"document"` - `retrieved_at: string | null` 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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaAdvisorToolResultBlock` - `content: BetaAdvisorToolResultError | BetaAdvisorResultBlock | BetaAdvisorRedactedResultBlock` - `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"` - `BetaAdvisorResultBlock` - `stop_reason: string | null` 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"` - `BetaAdvisorRedactedResultBlock` - `encrypted_content: string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `stop_reason: string | null` 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"` - `BetaCodeExecutionToolResultBlock` - `content: BetaCodeExecutionToolResultBlockContent` Code execution result with encrypted stdout for PFC + web_search results. - `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"` - `BetaCodeExecutionResultBlock` - `content: Array` - `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` Code execution result with encrypted stdout for PFC + web_search results. - `content: Array` - `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` - `content: BetaBashCodeExecutionToolResultError | BetaBashCodeExecutionResultBlock` - `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"` - `BetaBashCodeExecutionResultBlock` - `content: Array` - `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` - `content: BetaTextEditorCodeExecutionToolResultError | BetaTextEditorCodeExecutionViewResultBlock | BetaTextEditorCodeExecutionCreateResultBlock | BetaTextEditorCodeExecutionStrReplaceResultBlock` - `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 | null` - `type: "text_editor_code_execution_tool_result_error"` - `"text_editor_code_execution_tool_result_error"` - `BetaTextEditorCodeExecutionViewResultBlock` - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number | null` - `start_line: number | null` - `total_lines: number | null` - `type: "text_editor_code_execution_view_result"` - `"text_editor_code_execution_view_result"` - `BetaTextEditorCodeExecutionCreateResultBlock` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `"text_editor_code_execution_create_result"` - `BetaTextEditorCodeExecutionStrReplaceResultBlock` - `lines: Array | null` - `new_lines: number | null` - `new_start: number | null` - `old_lines: number | null` - `old_start: number | null` - `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` - `content: BetaToolSearchToolResultError | BetaToolSearchToolSearchResultBlock` - `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 | null` - `type: "tool_search_tool_result_error"` - `"tool_search_tool_result_error"` - `BetaToolSearchToolSearchResultBlock` - `tool_references: Array` - `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` - `id: string` - `input: Record` - `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` - `content: string | Array` - `string` - `Array` - `citations: Array | null` 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` Response model for a file uploaded to the container. - `file_id: string` - `type: "container_upload"` - `"container_upload"` - `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 | null` Summary of compacted content, or null if compaction failed - `encrypted_content: string | null` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction"` - `"compaction"` - `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. - `"claude-fable-5" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` - `to: BetaFallbackInfo` The fallback model producing the content that follows this block. Its `model` is always the canonical id. - `type: "fallback"` - `"fallback"` - `index: number` - `type: "content_block_start"` - `"content_block_start"` ### Beta Raw Content Block Stop Event - `BetaRawContentBlockStopEvent` - `index: number` - `type: "content_block_stop"` - `"content_block_stop"` ### Beta Raw Message Delta Event - `BetaRawMessageDeltaEvent` - `context_management: BetaContextManagementResponse | null` Information about context management strategies applied during the request - `applied_edits: Array` List of context management edits that were applied. - `BetaClearToolUses20250919EditResponse` - `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` - `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"` - `delta: Delta` - `container: BetaContainer | null` 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 | null` 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 - `stop_details: BetaRefusalStopDetails | null` Structured information about a refusal. - `category: "cyber" | "bio" | "reasoning_extraction" | null` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` - `"bio"` - `"reasoning_extraction"` - `explanation: string | null` 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 | null` 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: boolean | null` 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 | null` 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 | null` - `"end_turn"` - `"max_tokens"` - `"stop_sequence"` - `"tool_use"` - `"pause_turn"` - `"compaction"` - `"refusal"` - `"model_context_window_exceeded"` - `stop_sequence: string | null` - `type: "message_delta"` - `"message_delta"` - `usage: BetaMessageDeltaUsage` 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_input_tokens: number | null` The cumulative number of input tokens used to create the cache entry. - `cache_read_input_tokens: number | null` The cumulative number of input tokens read from the cache. - `input_tokens: number | null` The cumulative number of input tokens which were used. - `iterations: BetaIterationsUsage | null` 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` Token usage for a sampling iteration. - `cache_creation: BetaCacheCreation | null` 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. - `input_tokens: number` 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. - `"claude-fable-5" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` - `output_tokens: number` The number of output tokens which were used. - `type: "message"` Usage for a sampling iteration - `"message"` - `BetaCompactionIterationUsage` Token usage for a compaction iteration. - `cache_creation: BetaCacheCreation | null` 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` Token usage for an advisor sub-inference iteration. - `cache_creation: BetaCacheCreation | null` 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](https://docs.anthropic.com/en/docs/models-overview) 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"` - `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 | null` 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](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: number` 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: number` The cumulative number of output tokens which were used. - `output_tokens_details: BetaOutputTokensDetails | null` 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: number` 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 | null` 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. ### Beta Raw Message Start Event - `BetaRawMessageStartEvent` - `message: BetaMessage` - `id: string` Unique object identifier. The format and length of IDs may change over time. - `container: BetaContainer | null` 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 | null` 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` 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)"}] ``` - `BetaTextBlock` - `citations: Array | null` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `BetaCitationCharLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `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: number` - `document_title: string | null` - `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 | null` - `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` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `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: 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 | null` - `type: "search_result_location"` - `"search_result_location"` - `text: string` - `type: "text"` - `"text"` - `BetaThinkingBlock` - `signature: string` - `thinking: string` - `type: "thinking"` - `"thinking"` - `BetaRedactedThinkingBlock` - `data: string` - `type: "redacted_thinking"` - `"redacted_thinking"` - `BetaToolUseBlock` - `id: string` - `input: Record` - `name: string` - `type: "tool_use"` - `"tool_use"` - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `type: "direct"` - `"direct"` - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `BetaServerToolCaller20260120` - `tool_id: string` - `type: "code_execution_20260120"` - `"code_execution_20260120"` - `BetaServerToolUseBlock` - `id: string` - `input: Record` - `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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebSearchToolResultBlock` - `content: BetaWebSearchToolResultBlockContent` - `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"` - `Array` - `encrypted_content: string` - `page_age: string | null` - `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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebFetchToolResultBlock` - `content: BetaWebFetchToolResultErrorBlock | BetaWebFetchBlock` - `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"` - `BetaWebFetchBlock` - `content: BetaDocumentBlock` - `citations: BetaCitationConfig | null` Citation configuration for the document - `enabled: boolean` - `source: BetaBase64PDFSource | BetaPlainTextSource` - `BetaBase64PDFSource` - `data: string` - `media_type: "application/pdf"` - `"application/pdf"` - `type: "base64"` - `"base64"` - `BetaPlainTextSource` - `data: string` - `media_type: "text/plain"` - `"text/plain"` - `type: "text"` - `"text"` - `title: string | null` The title of the document - `type: "document"` - `"document"` - `retrieved_at: string | null` 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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaAdvisorToolResultBlock` - `content: BetaAdvisorToolResultError | BetaAdvisorResultBlock | BetaAdvisorRedactedResultBlock` - `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"` - `BetaAdvisorResultBlock` - `stop_reason: string | null` 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"` - `BetaAdvisorRedactedResultBlock` - `encrypted_content: string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `stop_reason: string | null` 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"` - `BetaCodeExecutionToolResultBlock` - `content: BetaCodeExecutionToolResultBlockContent` Code execution result with encrypted stdout for PFC + web_search results. - `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"` - `BetaCodeExecutionResultBlock` - `content: Array` - `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` Code execution result with encrypted stdout for PFC + web_search results. - `content: Array` - `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` - `content: BetaBashCodeExecutionToolResultError | BetaBashCodeExecutionResultBlock` - `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"` - `BetaBashCodeExecutionResultBlock` - `content: Array` - `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` - `content: BetaTextEditorCodeExecutionToolResultError | BetaTextEditorCodeExecutionViewResultBlock | BetaTextEditorCodeExecutionCreateResultBlock | BetaTextEditorCodeExecutionStrReplaceResultBlock` - `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 | null` - `type: "text_editor_code_execution_tool_result_error"` - `"text_editor_code_execution_tool_result_error"` - `BetaTextEditorCodeExecutionViewResultBlock` - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number | null` - `start_line: number | null` - `total_lines: number | null` - `type: "text_editor_code_execution_view_result"` - `"text_editor_code_execution_view_result"` - `BetaTextEditorCodeExecutionCreateResultBlock` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `"text_editor_code_execution_create_result"` - `BetaTextEditorCodeExecutionStrReplaceResultBlock` - `lines: Array | null` - `new_lines: number | null` - `new_start: number | null` - `old_lines: number | null` - `old_start: number | null` - `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` - `content: BetaToolSearchToolResultError | BetaToolSearchToolSearchResultBlock` - `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 | null` - `type: "tool_search_tool_result_error"` - `"tool_search_tool_result_error"` - `BetaToolSearchToolSearchResultBlock` - `tool_references: Array` - `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` - `id: string` - `input: Record` - `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` - `content: string | Array` - `string` - `Array` - `citations: Array | null` 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` Response model for a file uploaded to the container. - `file_id: string` - `type: "container_upload"` - `"container_upload"` - `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 | null` Summary of compacted content, or null if compaction failed - `encrypted_content: string | null` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction"` - `"compaction"` - `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. - `"claude-fable-5" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` - `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 | null` Context management response. Information about context management strategies applied during the request. - `applied_edits: Array` List of context management edits that were applied. - `BetaClearToolUses20250919EditResponse` - `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` - `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 | null` 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 | null` 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` - `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` - `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` - `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` - `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` - `type: "previous_message_not_found"` - `"previous_message_not_found"` - `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 | null` Structured information about a refusal. - `category: "cyber" | "bio" | "reasoning_extraction" | null` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` - `"bio"` - `"reasoning_extraction"` - `explanation: string | null` 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 | null` 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: boolean | null` 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 | null` 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 | null` 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 | null` 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 | null` 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 | null` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number | null` The number of input tokens read from the cache. - `inference_geo: string | null` The geographic region where inference was performed for this request. - `input_tokens: number` The number of input tokens which were used. - `iterations: BetaIterationsUsage | null` 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` Token usage for a sampling iteration. - `cache_creation: BetaCacheCreation | null` 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](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: number` The number of output tokens which were used. - `type: "message"` Usage for a sampling iteration - `"message"` - `BetaCompactionIterationUsage` Token usage for a compaction iteration. - `cache_creation: BetaCacheCreation | null` 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` Token usage for an advisor sub-inference iteration. - `cache_creation: BetaCacheCreation | null` 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](https://docs.anthropic.com/en/docs/models-overview) 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"` - `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 | null` 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](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: number` 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: number` The number of output tokens which were used. - `output_tokens_details: BetaOutputTokensDetails | null` 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: number` 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 | null` 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" | "priority" | "batch" | null` If the request used the priority, standard, or batch tier. - `"standard"` - `"priority"` - `"batch"` - `speed: "standard" | "fast" | null` The inference speed mode used for this request. - `"standard"` - `"fast"` - `type: "message_start"` - `"message_start"` ### Beta Raw Message Stop Event - `BetaRawMessageStopEvent` - `type: "message_stop"` - `"message_stop"` ### Beta Raw Message Stream Event - `BetaRawMessageStreamEvent = BetaRawMessageStartEvent | BetaRawMessageDeltaEvent | BetaRawMessageStopEvent | 3 more` - `BetaRawMessageStartEvent` - `message: BetaMessage` - `id: string` Unique object identifier. The format and length of IDs may change over time. - `container: BetaContainer | null` 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 | null` 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` 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)"}] ``` - `BetaTextBlock` - `citations: Array | null` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `BetaCitationCharLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `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: number` - `document_title: string | null` - `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 | null` - `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` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `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: 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 | null` - `type: "search_result_location"` - `"search_result_location"` - `text: string` - `type: "text"` - `"text"` - `BetaThinkingBlock` - `signature: string` - `thinking: string` - `type: "thinking"` - `"thinking"` - `BetaRedactedThinkingBlock` - `data: string` - `type: "redacted_thinking"` - `"redacted_thinking"` - `BetaToolUseBlock` - `id: string` - `input: Record` - `name: string` - `type: "tool_use"` - `"tool_use"` - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `type: "direct"` - `"direct"` - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `BetaServerToolCaller20260120` - `tool_id: string` - `type: "code_execution_20260120"` - `"code_execution_20260120"` - `BetaServerToolUseBlock` - `id: string` - `input: Record` - `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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebSearchToolResultBlock` - `content: BetaWebSearchToolResultBlockContent` - `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"` - `Array` - `encrypted_content: string` - `page_age: string | null` - `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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebFetchToolResultBlock` - `content: BetaWebFetchToolResultErrorBlock | BetaWebFetchBlock` - `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"` - `BetaWebFetchBlock` - `content: BetaDocumentBlock` - `citations: BetaCitationConfig | null` Citation configuration for the document - `enabled: boolean` - `source: BetaBase64PDFSource | BetaPlainTextSource` - `BetaBase64PDFSource` - `data: string` - `media_type: "application/pdf"` - `"application/pdf"` - `type: "base64"` - `"base64"` - `BetaPlainTextSource` - `data: string` - `media_type: "text/plain"` - `"text/plain"` - `type: "text"` - `"text"` - `title: string | null` The title of the document - `type: "document"` - `"document"` - `retrieved_at: string | null` 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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaAdvisorToolResultBlock` - `content: BetaAdvisorToolResultError | BetaAdvisorResultBlock | BetaAdvisorRedactedResultBlock` - `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"` - `BetaAdvisorResultBlock` - `stop_reason: string | null` 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"` - `BetaAdvisorRedactedResultBlock` - `encrypted_content: string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `stop_reason: string | null` 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"` - `BetaCodeExecutionToolResultBlock` - `content: BetaCodeExecutionToolResultBlockContent` Code execution result with encrypted stdout for PFC + web_search results. - `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"` - `BetaCodeExecutionResultBlock` - `content: Array` - `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` Code execution result with encrypted stdout for PFC + web_search results. - `content: Array` - `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` - `content: BetaBashCodeExecutionToolResultError | BetaBashCodeExecutionResultBlock` - `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"` - `BetaBashCodeExecutionResultBlock` - `content: Array` - `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` - `content: BetaTextEditorCodeExecutionToolResultError | BetaTextEditorCodeExecutionViewResultBlock | BetaTextEditorCodeExecutionCreateResultBlock | BetaTextEditorCodeExecutionStrReplaceResultBlock` - `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 | null` - `type: "text_editor_code_execution_tool_result_error"` - `"text_editor_code_execution_tool_result_error"` - `BetaTextEditorCodeExecutionViewResultBlock` - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number | null` - `start_line: number | null` - `total_lines: number | null` - `type: "text_editor_code_execution_view_result"` - `"text_editor_code_execution_view_result"` - `BetaTextEditorCodeExecutionCreateResultBlock` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `"text_editor_code_execution_create_result"` - `BetaTextEditorCodeExecutionStrReplaceResultBlock` - `lines: Array | null` - `new_lines: number | null` - `new_start: number | null` - `old_lines: number | null` - `old_start: number | null` - `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` - `content: BetaToolSearchToolResultError | BetaToolSearchToolSearchResultBlock` - `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 | null` - `type: "tool_search_tool_result_error"` - `"tool_search_tool_result_error"` - `BetaToolSearchToolSearchResultBlock` - `tool_references: Array` - `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` - `id: string` - `input: Record` - `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` - `content: string | Array` - `string` - `Array` - `citations: Array | null` 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` Response model for a file uploaded to the container. - `file_id: string` - `type: "container_upload"` - `"container_upload"` - `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 | null` Summary of compacted content, or null if compaction failed - `encrypted_content: string | null` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction"` - `"compaction"` - `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. - `"claude-fable-5" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` - `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 | null` Context management response. Information about context management strategies applied during the request. - `applied_edits: Array` List of context management edits that were applied. - `BetaClearToolUses20250919EditResponse` - `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` - `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 | null` 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 | null` 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` - `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` - `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` - `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` - `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` - `type: "previous_message_not_found"` - `"previous_message_not_found"` - `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 | null` Structured information about a refusal. - `category: "cyber" | "bio" | "reasoning_extraction" | null` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` - `"bio"` - `"reasoning_extraction"` - `explanation: string | null` 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 | null` 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: boolean | null` 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 | null` 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 | null` 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 | null` 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 | null` 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 | null` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number | null` The number of input tokens read from the cache. - `inference_geo: string | null` The geographic region where inference was performed for this request. - `input_tokens: number` The number of input tokens which were used. - `iterations: BetaIterationsUsage | null` 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` Token usage for a sampling iteration. - `cache_creation: BetaCacheCreation | null` 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](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: number` The number of output tokens which were used. - `type: "message"` Usage for a sampling iteration - `"message"` - `BetaCompactionIterationUsage` Token usage for a compaction iteration. - `cache_creation: BetaCacheCreation | null` 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` Token usage for an advisor sub-inference iteration. - `cache_creation: BetaCacheCreation | null` 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](https://docs.anthropic.com/en/docs/models-overview) 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"` - `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 | null` 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](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: number` 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: number` The number of output tokens which were used. - `output_tokens_details: BetaOutputTokensDetails | null` 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: number` 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 | null` 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" | "priority" | "batch" | null` If the request used the priority, standard, or batch tier. - `"standard"` - `"priority"` - `"batch"` - `speed: "standard" | "fast" | null` The inference speed mode used for this request. - `"standard"` - `"fast"` - `type: "message_start"` - `"message_start"` - `BetaRawMessageDeltaEvent` - `context_management: BetaContextManagementResponse | null` Information about context management strategies applied during the request - `delta: Delta` - `container: BetaContainer | null` Information about the container used in the request (for the code execution tool) - `stop_details: BetaRefusalStopDetails | null` Structured information about a refusal. - `stop_reason: BetaStopReason | null` - `stop_sequence: string | null` - `type: "message_delta"` - `"message_delta"` - `usage: BetaMessageDeltaUsage` 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_input_tokens: number | null` The cumulative number of input tokens used to create the cache entry. - `cache_read_input_tokens: number | null` The cumulative number of input tokens read from the cache. - `input_tokens: number | null` The cumulative number of input tokens which were used. - `iterations: BetaIterationsUsage | null` 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 - `output_tokens: number` The cumulative number of output tokens which were used. - `output_tokens_details: BetaOutputTokensDetails | null` 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. - `server_tool_use: BetaServerToolUsage | null` The number of server tool requests. - `BetaRawMessageStopEvent` - `type: "message_stop"` - `"message_stop"` - `BetaRawContentBlockStartEvent` - `content_block: BetaTextBlock | BetaThinkingBlock | BetaRedactedThinkingBlock | 14 more` Response model for a file uploaded to the container. - `BetaTextBlock` - `BetaThinkingBlock` - `BetaRedactedThinkingBlock` - `BetaToolUseBlock` - `BetaServerToolUseBlock` - `BetaWebSearchToolResultBlock` - `BetaWebFetchToolResultBlock` - `BetaAdvisorToolResultBlock` - `BetaCodeExecutionToolResultBlock` - `BetaBashCodeExecutionToolResultBlock` - `BetaTextEditorCodeExecutionToolResultBlock` - `BetaToolSearchToolResultBlock` - `BetaMCPToolUseBlock` - `BetaMCPToolResultBlock` - `BetaContainerUploadBlock` Response model for a file uploaded to the container. - `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. - `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. - `index: number` - `type: "content_block_start"` - `"content_block_start"` - `BetaRawContentBlockDeltaEvent` - `delta: BetaRawContentBlockDelta` - `BetaTextDelta` - `text: string` - `type: "text_delta"` - `"text_delta"` - `BetaInputJSONDelta` - `partial_json: string` - `type: "input_json_delta"` - `"input_json_delta"` - `BetaCitationsDelta` - `citation: BetaCitationCharLocation | BetaCitationPageLocation | BetaCitationContentBlockLocation | 2 more` - `BetaCitationCharLocation` - `BetaCitationPageLocation` - `BetaCitationContentBlockLocation` - `BetaCitationsWebSearchResultLocation` - `BetaCitationSearchResultLocation` - `type: "citations_delta"` - `"citations_delta"` - `BetaThinkingDelta` - `estimated_tokens: number | null` Per-frame increment of a coarse, running estimate of the tokens this thinking block has produced so far. Present whenever the `thinking-token-count-2026-05-13` beta is set; `null` unless `thinking.display` resolves to `"omitted"` and a count is due this frame. Sum the increments across `thinking_delta` frames on this block for a progress indicator. Each increment is a non-negative multiple of a fixed quantum and the cadence is rate-limited, so this is a deliberately lossy display hint, not a billable count; `usage.output_tokens` remains authoritative. - `thinking: string` - `type: "thinking_delta"` - `"thinking_delta"` - `BetaSignatureDelta` - `signature: string` - `type: "signature_delta"` - `"signature_delta"` - `BetaCompactionContentBlockDelta` - `content: string | null` - `encrypted_content: string | null` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction_delta"` - `"compaction_delta"` - `index: number` - `type: "content_block_delta"` - `"content_block_delta"` - `BetaRawContentBlockStopEvent` - `index: number` - `type: "content_block_stop"` - `"content_block_stop"` ### Beta Redacted Thinking Block - `BetaRedactedThinkingBlock` - `data: string` - `type: "redacted_thinking"` - `"redacted_thinking"` ### Beta Redacted Thinking Block Param - `BetaRedactedThinkingBlockParam` - `data: string` - `type: "redacted_thinking"` - `"redacted_thinking"` ### Beta Refusal Stop Details - `BetaRefusalStopDetails` Structured information about a refusal. - `category: "cyber" | "bio" | "reasoning_extraction" | null` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` - `"bio"` - `"reasoning_extraction"` - `explanation: string | null` 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 | null` 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: boolean | null` 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 | null` 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"` ### Beta Request Document Block - `BetaRequestDocumentBlock` - `source: BetaBase64PDFSource | BetaPlainTextSource | BetaContentBlockSource | 2 more` - `BetaBase64PDFSource` - `data: string` - `media_type: "application/pdf"` - `"application/pdf"` - `type: "base64"` - `"base64"` - `BetaPlainTextSource` - `data: string` - `media_type: "text/plain"` - `"text/plain"` - `type: "text"` - `"text"` - `BetaContentBlockSource` - `content: string | Array` - `string` - `Array` - `BetaTextBlockParam` - `text: string` - `type: "text"` - `"text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `citations?: Array | null` - `BetaCitationCharLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `BetaCitationContentBlockLocationParam` - `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 | null` - `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`. - `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"` - `BetaCitationWebSearchResultLocationParam` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `BetaCitationSearchResultLocationParam` - `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 | null` - `type: "search_result_location"` - `"search_result_location"` - `BetaImageBlockParam` - `source: BetaBase64ImageSource | BetaURLImageSource | BetaFileImageSource` - `BetaBase64ImageSource` - `data: string` - `media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `type: "base64"` - `"base64"` - `BetaURLImageSource` - `type: "url"` - `"url"` - `url: string` - `BetaFileImageSource` - `file_id: string` - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "content"` - `"content"` - `BetaURLPDFSource` - `type: "url"` - `"url"` - `url: string` - `BetaFileDocumentSource` - `file_id: string` - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam | null` - `enabled?: boolean` - `context?: string | null` - `title?: string | null` ### Beta Request MCP Server Tool Configuration - `BetaRequestMCPServerToolConfiguration` - `allowed_tools?: Array | null` - `enabled?: boolean | null` ### Beta Request MCP Server URL Definition - `BetaRequestMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `authorization_token?: string | null` - `tool_configuration?: BetaRequestMCPServerToolConfiguration | null` - `allowed_tools?: Array | null` - `enabled?: boolean | null` ### Beta Request MCP Tool Result Block Param - `BetaRequestMCPToolResultBlockParam` - `tool_use_id: string` - `type: "mcp_tool_result"` - `"mcp_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `content?: string | Array` - `string` - `Array` - `text: string` - `type: "text"` - `"text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `BetaCitationCharLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `BetaCitationContentBlockLocationParam` - `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 | null` - `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`. - `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"` - `BetaCitationWebSearchResultLocationParam` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `BetaCitationSearchResultLocationParam` - `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 | null` - `type: "search_result_location"` - `"search_result_location"` - `is_error?: boolean` ### Beta Search Result Block Param - `BetaSearchResultBlockParam` - `content: Array` - `text: string` - `type: "text"` - `"text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `citations?: Array | null` - `BetaCitationCharLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `BetaCitationContentBlockLocationParam` - `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 | null` - `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`. - `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"` - `BetaCitationWebSearchResultLocationParam` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `BetaCitationSearchResultLocationParam` - `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 | null` - `type: "search_result_location"` - `"search_result_location"` - `source: string` - `title: string` - `type: "search_result"` - `"search_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam` - `enabled?: boolean` ### Beta Server Tool Caller - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `"code_execution_20250825"` ### Beta Server Tool Caller 20260120 - `BetaServerToolCaller20260120` - `tool_id: string` - `type: "code_execution_20260120"` - `"code_execution_20260120"` ### Beta Server Tool Usage - `BetaServerToolUsage` - `web_fetch_requests: number` The number of web fetch tool requests. - `web_search_requests: number` The number of web search tool requests. ### Beta Server Tool Use Block - `BetaServerToolUseBlock` - `id: string` - `input: Record` - `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. - `BetaDirectCaller` Tool invocation directly from the model. - `type: "direct"` - `"direct"` - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `BetaServerToolCaller20260120` - `tool_id: string` - `type: "code_execution_20260120"` - `"code_execution_20260120"` ### Beta Server Tool Use Block Param - `BetaServerToolUseBlockParam` - `id: string` - `input: Record` - `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"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `type: "direct"` - `"direct"` - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `BetaServerToolCaller20260120` - `tool_id: string` - `type: "code_execution_20260120"` - `"code_execution_20260120"` ### Beta Signature Delta - `BetaSignatureDelta` - `signature: string` - `type: "signature_delta"` - `"signature_delta"` ### Beta Skill - `BetaSkill` A skill that was loaded in a container (response model). - `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 ### Beta Skill Params - `BetaSkillParams` Specification for a skill to be loaded in a container (request model). - `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 ### Beta Stop Reason - `BetaStopReason = "end_turn" | "max_tokens" | "stop_sequence" | 5 more` - `"end_turn"` - `"max_tokens"` - `"stop_sequence"` - `"tool_use"` - `"pause_turn"` - `"compaction"` - `"refusal"` - `"model_context_window_exceeded"` ### Beta Text Block - `BetaTextBlock` - `citations: Array | null` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `BetaCitationCharLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `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: number` - `document_title: string | null` - `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 | null` - `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` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `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: 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 | null` - `type: "search_result_location"` - `"search_result_location"` - `text: string` - `type: "text"` - `"text"` ### Beta Text Block Param - `BetaTextBlockParam` - `text: string` - `type: "text"` - `"text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `citations?: Array | null` - `BetaCitationCharLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `BetaCitationContentBlockLocationParam` - `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 | null` - `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`. - `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"` - `BetaCitationWebSearchResultLocationParam` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `BetaCitationSearchResultLocationParam` - `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 | null` - `type: "search_result_location"` - `"search_result_location"` ### Beta Text Citation - `BetaTextCitation = BetaCitationCharLocation | BetaCitationPageLocation | BetaCitationContentBlockLocation | 2 more` - `BetaCitationCharLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `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: number` - `document_title: string | null` - `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 | null` - `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` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `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: 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 | null` - `type: "search_result_location"` - `"search_result_location"` ### Beta Text Citation Param - `BetaTextCitationParam = BetaCitationCharLocationParam | BetaCitationPageLocationParam | BetaCitationContentBlockLocationParam | 2 more` - `BetaCitationCharLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `BetaCitationContentBlockLocationParam` - `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 | null` - `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`. - `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"` - `BetaCitationWebSearchResultLocationParam` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `BetaCitationSearchResultLocationParam` - `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 | null` - `type: "search_result_location"` - `"search_result_location"` ### Beta Text Delta - `BetaTextDelta` - `text: string` - `type: "text_delta"` - `"text_delta"` ### Beta Text Editor Code Execution Create Result Block - `BetaTextEditorCodeExecutionCreateResultBlock` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `"text_editor_code_execution_create_result"` ### Beta Text Editor Code Execution Create Result Block Param - `BetaTextEditorCodeExecutionCreateResultBlockParam` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `"text_editor_code_execution_create_result"` ### Beta Text Editor Code Execution Str Replace Result Block - `BetaTextEditorCodeExecutionStrReplaceResultBlock` - `lines: Array | null` - `new_lines: number | null` - `new_start: number | null` - `old_lines: number | null` - `old_start: number | null` - `type: "text_editor_code_execution_str_replace_result"` - `"text_editor_code_execution_str_replace_result"` ### Beta Text Editor Code Execution Str Replace Result Block Param - `BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `type: "text_editor_code_execution_str_replace_result"` - `"text_editor_code_execution_str_replace_result"` - `lines?: Array | null` - `new_lines?: number | null` - `new_start?: number | null` - `old_lines?: number | null` - `old_start?: number | null` ### Beta Text Editor Code Execution Tool Result Block - `BetaTextEditorCodeExecutionToolResultBlock` - `content: BetaTextEditorCodeExecutionToolResultError | BetaTextEditorCodeExecutionViewResultBlock | BetaTextEditorCodeExecutionCreateResultBlock | BetaTextEditorCodeExecutionStrReplaceResultBlock` - `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 | null` - `type: "text_editor_code_execution_tool_result_error"` - `"text_editor_code_execution_tool_result_error"` - `BetaTextEditorCodeExecutionViewResultBlock` - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number | null` - `start_line: number | null` - `total_lines: number | null` - `type: "text_editor_code_execution_view_result"` - `"text_editor_code_execution_view_result"` - `BetaTextEditorCodeExecutionCreateResultBlock` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `"text_editor_code_execution_create_result"` - `BetaTextEditorCodeExecutionStrReplaceResultBlock` - `lines: Array | null` - `new_lines: number | null` - `new_start: number | null` - `old_lines: number | null` - `old_start: number | null` - `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"` ### Beta Text Editor Code Execution Tool Result Block Param - `BetaTextEditorCodeExecutionToolResultBlockParam` - `content: BetaTextEditorCodeExecutionToolResultErrorParam | BetaTextEditorCodeExecutionViewResultBlockParam | BetaTextEditorCodeExecutionCreateResultBlockParam | BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `BetaTextEditorCodeExecutionToolResultErrorParam` - `error_code: "invalid_tool_input" | "unavailable" | "too_many_requests" | 2 more` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `type: "text_editor_code_execution_tool_result_error"` - `"text_editor_code_execution_tool_result_error"` - `error_message?: string | null` - `BetaTextEditorCodeExecutionViewResultBlockParam` - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `type: "text_editor_code_execution_view_result"` - `"text_editor_code_execution_view_result"` - `num_lines?: number | null` - `start_line?: number | null` - `total_lines?: number | null` - `BetaTextEditorCodeExecutionCreateResultBlockParam` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `"text_editor_code_execution_create_result"` - `BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `type: "text_editor_code_execution_str_replace_result"` - `"text_editor_code_execution_str_replace_result"` - `lines?: Array | null` - `new_lines?: number | null` - `new_start?: number | null` - `old_lines?: number | null` - `old_start?: number | null` - `tool_use_id: string` - `type: "text_editor_code_execution_tool_result"` - `"text_editor_code_execution_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` ### Beta Text Editor Code Execution Tool Result Error - `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 | null` - `type: "text_editor_code_execution_tool_result_error"` - `"text_editor_code_execution_tool_result_error"` ### Beta Text Editor Code Execution Tool Result Error Param - `BetaTextEditorCodeExecutionToolResultErrorParam` - `error_code: "invalid_tool_input" | "unavailable" | "too_many_requests" | 2 more` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `type: "text_editor_code_execution_tool_result_error"` - `"text_editor_code_execution_tool_result_error"` - `error_message?: string | null` ### Beta Text Editor Code Execution View Result Block - `BetaTextEditorCodeExecutionViewResultBlock` - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number | null` - `start_line: number | null` - `total_lines: number | null` - `type: "text_editor_code_execution_view_result"` - `"text_editor_code_execution_view_result"` ### Beta Text Editor Code Execution View Result Block Param - `BetaTextEditorCodeExecutionViewResultBlockParam` - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `type: "text_editor_code_execution_view_result"` - `"text_editor_code_execution_view_result"` - `num_lines?: number | null` - `start_line?: number | null` - `total_lines?: number | null` ### Beta Thinking Block - `BetaThinkingBlock` - `signature: string` - `thinking: string` - `type: "thinking"` - `"thinking"` ### Beta Thinking Block Param - `BetaThinkingBlockParam` - `signature: string` - `thinking: string` - `type: "thinking"` - `"thinking"` ### Beta Thinking Config Adaptive - `BetaThinkingConfigAdaptive` - `type: "adaptive"` - `"adaptive"` - `display?: "summarized" | "omitted" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. - `"summarized"` - `"omitted"` ### Beta Thinking Config Disabled - `BetaThinkingConfigDisabled` - `type: "disabled"` - `"disabled"` ### Beta Thinking Config Enabled - `BetaThinkingConfigEnabled` - `budget_tokens: number` Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality. Must be ≥1024 and less than `max_tokens`. See [extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details. - `type: "enabled"` - `"enabled"` - `display?: "summarized" | "omitted" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. - `"summarized"` - `"omitted"` ### Beta Thinking Config Param - `BetaThinkingConfigParam = BetaThinkingConfigEnabled | BetaThinkingConfigDisabled | BetaThinkingConfigAdaptive` Configuration for enabling Claude's extended thinking. When enabled, responses include `thinking` content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your `max_tokens` limit. See [extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details. - `BetaThinkingConfigEnabled` - `budget_tokens: number` Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality. Must be ≥1024 and less than `max_tokens`. See [extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details. - `type: "enabled"` - `"enabled"` - `display?: "summarized" | "omitted" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. - `"summarized"` - `"omitted"` - `BetaThinkingConfigDisabled` - `type: "disabled"` - `"disabled"` - `BetaThinkingConfigAdaptive` - `type: "adaptive"` - `"adaptive"` - `display?: "summarized" | "omitted" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. - `"summarized"` - `"omitted"` ### Beta Thinking Delta - `BetaThinkingDelta` - `estimated_tokens: number | null` Per-frame increment of a coarse, running estimate of the tokens this thinking block has produced so far. Present whenever the `thinking-token-count-2026-05-13` beta is set; `null` unless `thinking.display` resolves to `"omitted"` and a count is due this frame. Sum the increments across `thinking_delta` frames on this block for a progress indicator. Each increment is a non-negative multiple of a fixed quantum and the cadence is rate-limited, so this is a deliberately lossy display hint, not a billable count; `usage.output_tokens` remains authoritative. - `thinking: string` - `type: "thinking_delta"` - `"thinking_delta"` ### Beta Thinking Turns - `BetaThinkingTurns` - `type: "thinking_turns"` - `"thinking_turns"` - `value: number` ### Beta Token Task Budget - `BetaTokenTaskBudget` User-configurable total token budget across contexts. - `total: number` Total token budget across all contexts in the session. - `type: "tokens"` The budget type. Currently only 'tokens' is supported. - `"tokens"` - `remaining?: number | null` Remaining tokens in the budget. Use this to track usage across contexts when implementing compaction client-side. Defaults to total if not provided. ### Beta Tool - `BetaTool` - `input_schema: InputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `type: "object"` - `"object"` - `properties?: Record | null` - `required?: Array | null` - `name: string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `description?: string` Description of what this tool does. Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema. - `eager_input_streaming?: boolean | null` Enable eager input streaming for this tool. When true, tool input parameters will be streamed incrementally as they are generated, and types will be inferred on-the-fly rather than buffering the full JSON output. When false, streaming is disabled for this tool even if the fine-grained-tool-streaming beta is active. When null (default), uses the default behavior based on beta headers. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `type?: "custom" | null` - `"custom"` ### Beta Tool Bash 20241022 - `BetaToolBash20241022` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"bash"` - `type: "bash_20241022"` - `"bash_20241022"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Beta Tool Bash 20250124 - `BetaToolBash20250124` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"bash"` - `type: "bash_20250124"` - `"bash_20250124"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Beta Tool Choice - `BetaToolChoice = BetaToolChoiceAuto | BetaToolChoiceAny | BetaToolChoiceTool | BetaToolChoiceNone` How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. - `BetaToolChoiceAuto` The model will automatically decide whether to use tools. - `type: "auto"` - `"auto"` - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output at most one tool use. - `BetaToolChoiceAny` The model will use any available tools. - `type: "any"` - `"any"` - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `BetaToolChoiceTool` The model will use the specified tool with `tool_choice.name`. - `name: string` The name of the tool to use. - `type: "tool"` - `"tool"` - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `BetaToolChoiceNone` The model will not be allowed to use tools. - `type: "none"` - `"none"` ### Beta Tool Choice Any - `BetaToolChoiceAny` The model will use any available tools. - `type: "any"` - `"any"` - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. ### Beta Tool Choice Auto - `BetaToolChoiceAuto` The model will automatically decide whether to use tools. - `type: "auto"` - `"auto"` - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output at most one tool use. ### Beta Tool Choice None - `BetaToolChoiceNone` The model will not be allowed to use tools. - `type: "none"` - `"none"` ### Beta Tool Choice Tool - `BetaToolChoiceTool` The model will use the specified tool with `tool_choice.name`. - `name: string` The name of the tool to use. - `type: "tool"` - `"tool"` - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. ### Beta Tool Computer Use 20241022 - `BetaToolComputerUse20241022` - `display_height_px: number` The height of the display in pixels. - `display_width_px: number` The width of the display in pixels. - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"computer"` - `type: "computer_20241022"` - `"computer_20241022"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number?: number | null` The X11 display number (e.g. 0, 1) for the display. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Beta Tool Computer Use 20250124 - `BetaToolComputerUse20250124` - `display_height_px: number` The height of the display in pixels. - `display_width_px: number` The width of the display in pixels. - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"computer"` - `type: "computer_20250124"` - `"computer_20250124"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number?: number | null` The X11 display number (e.g. 0, 1) for the display. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Beta Tool Computer Use 20251124 - `BetaToolComputerUse20251124` - `display_height_px: number` The height of the display in pixels. - `display_width_px: number` The width of the display in pixels. - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"computer"` - `type: "computer_20251124"` - `"computer_20251124"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number?: number | null` The X11 display number (e.g. 0, 1) for the display. - `enable_zoom?: boolean` Whether to enable an action to take a zoomed-in screenshot of the screen. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Beta Tool Reference Block - `BetaToolReferenceBlock` - `tool_name: string` - `type: "tool_reference"` - `"tool_reference"` ### Beta Tool Reference Block Param - `BetaToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `tool_name: string` - `type: "tool_reference"` - `"tool_reference"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` ### Beta Tool Result Block Param - `BetaToolResultBlockParam` - `tool_use_id: string` - `type: "tool_result"` - `"tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `content?: string | Array` - `string` - `Array` - `BetaTextBlockParam` - `text: string` - `type: "text"` - `"text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `BetaCitationCharLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `BetaCitationContentBlockLocationParam` - `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 | null` - `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`. - `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"` - `BetaCitationWebSearchResultLocationParam` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `BetaCitationSearchResultLocationParam` - `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 | null` - `type: "search_result_location"` - `"search_result_location"` - `BetaImageBlockParam` - `source: BetaBase64ImageSource | BetaURLImageSource | BetaFileImageSource` - `BetaBase64ImageSource` - `data: string` - `media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `type: "base64"` - `"base64"` - `BetaURLImageSource` - `type: "url"` - `"url"` - `url: string` - `BetaFileImageSource` - `file_id: string` - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaSearchResultBlockParam` - `content: Array` - `text: string` - `type: "text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `source: string` - `title: string` - `type: "search_result"` - `"search_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam` - `enabled?: boolean` - `BetaRequestDocumentBlock` - `source: BetaBase64PDFSource | BetaPlainTextSource | BetaContentBlockSource | 2 more` - `BetaBase64PDFSource` - `data: string` - `media_type: "application/pdf"` - `"application/pdf"` - `type: "base64"` - `"base64"` - `BetaPlainTextSource` - `data: string` - `media_type: "text/plain"` - `"text/plain"` - `type: "text"` - `"text"` - `BetaContentBlockSource` - `content: string | Array` - `string` - `Array` - `BetaTextBlockParam` - `BetaImageBlockParam` - `type: "content"` - `"content"` - `BetaURLPDFSource` - `type: "url"` - `"url"` - `url: string` - `BetaFileDocumentSource` - `file_id: string` - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam | null` - `context?: string | null` - `title?: string | null` - `BetaToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `tool_name: string` - `type: "tool_reference"` - `"tool_reference"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `is_error?: boolean` ### Beta Tool Search Tool Bm25 20251119 - `BetaToolSearchToolBm25_20251119` - `name: "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"tool_search_tool_bm25"` - `type: "tool_search_tool_bm25_20251119" | "tool_search_tool_bm25"` - `"tool_search_tool_bm25_20251119"` - `"tool_search_tool_bm25"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Beta Tool Search Tool Regex 20251119 - `BetaToolSearchToolRegex20251119` - `name: "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"tool_search_tool_regex"` - `type: "tool_search_tool_regex_20251119" | "tool_search_tool_regex"` - `"tool_search_tool_regex_20251119"` - `"tool_search_tool_regex"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Beta Tool Search Tool Result Block - `BetaToolSearchToolResultBlock` - `content: BetaToolSearchToolResultError | BetaToolSearchToolSearchResultBlock` - `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 | null` - `type: "tool_search_tool_result_error"` - `"tool_search_tool_result_error"` - `BetaToolSearchToolSearchResultBlock` - `tool_references: Array` - `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"` ### Beta Tool Search Tool Result Block Param - `BetaToolSearchToolResultBlockParam` - `content: BetaToolSearchToolResultErrorParam | BetaToolSearchToolSearchResultBlockParam` - `BetaToolSearchToolResultErrorParam` - `error_code: "invalid_tool_input" | "unavailable" | "too_many_requests" | "execution_time_exceeded"` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `type: "tool_search_tool_result_error"` - `"tool_search_tool_result_error"` - `error_message?: string | null` - `BetaToolSearchToolSearchResultBlockParam` - `tool_references: Array` - `tool_name: string` - `type: "tool_reference"` - `"tool_reference"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `type: "tool_search_tool_search_result"` - `"tool_search_tool_search_result"` - `tool_use_id: string` - `type: "tool_search_tool_result"` - `"tool_search_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. ### Beta Tool Search Tool Result Error - `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 | null` - `type: "tool_search_tool_result_error"` - `"tool_search_tool_result_error"` ### Beta Tool Search Tool Result Error Param - `BetaToolSearchToolResultErrorParam` - `error_code: "invalid_tool_input" | "unavailable" | "too_many_requests" | "execution_time_exceeded"` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `type: "tool_search_tool_result_error"` - `"tool_search_tool_result_error"` - `error_message?: string | null` ### Beta Tool Search Tool Search Result Block - `BetaToolSearchToolSearchResultBlock` - `tool_references: Array` - `tool_name: string` - `type: "tool_reference"` - `"tool_reference"` - `type: "tool_search_tool_search_result"` - `"tool_search_tool_search_result"` ### Beta Tool Search Tool Search Result Block Param - `BetaToolSearchToolSearchResultBlockParam` - `tool_references: Array` - `tool_name: string` - `type: "tool_reference"` - `"tool_reference"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `type: "tool_search_tool_search_result"` - `"tool_search_tool_search_result"` ### Beta Tool Text Editor 20241022 - `BetaToolTextEditor20241022` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"str_replace_editor"` - `type: "text_editor_20241022"` - `"text_editor_20241022"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Beta Tool Text Editor 20250124 - `BetaToolTextEditor20250124` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"str_replace_editor"` - `type: "text_editor_20250124"` - `"text_editor_20250124"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Beta Tool Text Editor 20250429 - `BetaToolTextEditor20250429` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"str_replace_based_edit_tool"` - `type: "text_editor_20250429"` - `"text_editor_20250429"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Beta Tool Text Editor 20250728 - `BetaToolTextEditor20250728` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"str_replace_based_edit_tool"` - `type: "text_editor_20250728"` - `"text_editor_20250728"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `max_characters?: number | null` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Beta Tool Union - `BetaToolUnion = BetaTool | BetaToolBash20241022 | BetaToolBash20250124 | 20 more` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `BetaTool` - `input_schema: InputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `type: "object"` - `"object"` - `properties?: Record | null` - `required?: Array | null` - `name: string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `description?: string` Description of what this tool does. Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema. - `eager_input_streaming?: boolean | null` Enable eager input streaming for this tool. When true, tool input parameters will be streamed incrementally as they are generated, and types will be inferred on-the-fly rather than buffering the full JSON output. When false, streaming is disabled for this tool even if the fine-grained-tool-streaming beta is active. When null (default), uses the default behavior based on beta headers. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `type?: "custom" | null` - `"custom"` - `BetaToolBash20241022` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"bash"` - `type: "bash_20241022"` - `"bash_20241022"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolBash20250124` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"bash"` - `type: "bash_20250124"` - `"bash_20250124"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20250522` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"code_execution"` - `type: "code_execution_20250522"` - `"code_execution_20250522"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20250825` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"code_execution"` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"code_execution"` - `type: "code_execution_20260120"` - `"code_execution_20260120"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolComputerUse20241022` - `display_height_px: number` The height of the display in pixels. - `display_width_px: number` The width of the display in pixels. - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"computer"` - `type: "computer_20241022"` - `"computer_20241022"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number?: number | null` The X11 display number (e.g. 0, 1) for the display. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaMemoryTool20250818` - `name: "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"memory"` - `type: "memory_20250818"` - `"memory_20250818"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolComputerUse20250124` - `display_height_px: number` The height of the display in pixels. - `display_width_px: number` The width of the display in pixels. - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"computer"` - `type: "computer_20250124"` - `"computer_20250124"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number?: number | null` The X11 display number (e.g. 0, 1) for the display. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20241022` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"str_replace_editor"` - `type: "text_editor_20241022"` - `"text_editor_20241022"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolComputerUse20251124` - `display_height_px: number` The height of the display in pixels. - `display_width_px: number` The width of the display in pixels. - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"computer"` - `type: "computer_20251124"` - `"computer_20251124"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number?: number | null` The X11 display number (e.g. 0, 1) for the display. - `enable_zoom?: boolean` Whether to enable an action to take a zoomed-in screenshot of the screen. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20250124` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"str_replace_editor"` - `type: "text_editor_20250124"` - `"text_editor_20250124"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20250429` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"str_replace_based_edit_tool"` - `type: "text_editor_20250429"` - `"text_editor_20250429"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20250728` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"str_replace_based_edit_tool"` - `type: "text_editor_20250728"` - `"text_editor_20250728"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `max_characters?: number | null` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaWebSearchTool20250305` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"web_search"` - `type: "web_search_20250305"` - `"web_search_20250305"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: BetaUserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `type: "approximate"` - `"approximate"` - `city?: string | null` The city of the user. - `country?: string | null` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. - `region?: string | null` The region of the user. - `timezone?: string | null` The [IANA timezone](https://nodatime.org/TimeZones) of the user. - `BetaWebFetchTool20250910` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"web_fetch"` - `type: "web_fetch_20250910"` - `"web_fetch_20250910"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `enabled?: boolean` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaWebSearchTool20260209` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"web_search"` - `type: "web_search_20260209"` - `"web_search_20260209"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: BetaUserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `BetaWebFetchTool20260209` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"web_fetch"` - `type: "web_fetch_20260209"` - `"web_fetch_20260209"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"web_fetch"` - `type: "web_fetch_20260309"` - `"web_fetch_20260309"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `use_cache?: boolean` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `BetaAdvisorTool20260301` - `model: Model` 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" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` - `name: "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"advisor"` - `type: "advisor_20260301"` - `"advisor_20260301"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caching?: BetaCacheControlEphemeral | null` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_tokens?: number | null` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolSearchToolBm25_20251119` - `name: "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"tool_search_tool_bm25"` - `type: "tool_search_tool_bm25_20251119" | "tool_search_tool_bm25"` - `"tool_search_tool_bm25_20251119"` - `"tool_search_tool_bm25"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolSearchToolRegex20251119` - `name: "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"tool_search_tool_regex"` - `type: "tool_search_tool_regex_20251119" | "tool_search_tool_regex"` - `"tool_search_tool_regex_20251119"` - `"tool_search_tool_regex"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `mcp_server_name: string` Name of the MCP server to configure tools for - `type: "mcp_toolset"` - `"mcp_toolset"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `configs?: Record | null` Configuration overrides for specific tools, keyed by tool name - `defer_loading?: boolean` - `enabled?: boolean` - `default_config?: BetaMCPToolDefaultConfig` Default configuration applied to all tools from this server - `defer_loading?: boolean` - `enabled?: boolean` ### Beta Tool Use Block - `BetaToolUseBlock` - `id: string` - `input: Record` - `name: string` - `type: "tool_use"` - `"tool_use"` - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `type: "direct"` - `"direct"` - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `BetaServerToolCaller20260120` - `tool_id: string` - `type: "code_execution_20260120"` - `"code_execution_20260120"` ### Beta Tool Use Block Param - `BetaToolUseBlockParam` - `id: string` - `input: Record` - `name: string` - `type: "tool_use"` - `"tool_use"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `type: "direct"` - `"direct"` - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `BetaServerToolCaller20260120` - `tool_id: string` - `type: "code_execution_20260120"` - `"code_execution_20260120"` ### Beta Tool Uses Keep - `BetaToolUsesKeep` - `type: "tool_uses"` - `"tool_uses"` - `value: number` ### Beta Tool Uses Trigger - `BetaToolUsesTrigger` - `type: "tool_uses"` - `"tool_uses"` - `value: number` ### Beta URL Image Source - `BetaURLImageSource` - `type: "url"` - `"url"` - `url: string` ### Beta URL PDF Source - `BetaURLPDFSource` - `type: "url"` - `"url"` - `url: string` ### Beta Usage - `BetaUsage` - `cache_creation: BetaCacheCreation | null` 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 | null` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number | null` The number of input tokens read from the cache. - `inference_geo: string | null` The geographic region where inference was performed for this request. - `input_tokens: number` The number of input tokens which were used. - `iterations: BetaIterationsUsage | null` 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` Token usage for a sampling iteration. - `cache_creation: BetaCacheCreation | null` 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](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-fable-5" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` - `output_tokens: number` The number of output tokens which were used. - `type: "message"` Usage for a sampling iteration - `"message"` - `BetaCompactionIterationUsage` Token usage for a compaction iteration. - `cache_creation: BetaCacheCreation | null` 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` Token usage for an advisor sub-inference iteration. - `cache_creation: BetaCacheCreation | null` 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](https://docs.anthropic.com/en/docs/models-overview) 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"` - `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 | null` 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](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: number` 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: number` The number of output tokens which were used. - `output_tokens_details: BetaOutputTokensDetails | null` 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: number` 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 | null` 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" | "priority" | "batch" | null` If the request used the priority, standard, or batch tier. - `"standard"` - `"priority"` - `"batch"` - `speed: "standard" | "fast" | null` The inference speed mode used for this request. - `"standard"` - `"fast"` ### Beta User Location - `BetaUserLocation` - `type: "approximate"` - `"approximate"` - `city?: string | null` The city of the user. - `country?: string | null` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. - `region?: string | null` The region of the user. - `timezone?: string | null` The [IANA timezone](https://nodatime.org/TimeZones) of the user. ### Beta Web Fetch Block - `BetaWebFetchBlock` - `content: BetaDocumentBlock` - `citations: BetaCitationConfig | null` Citation configuration for the document - `enabled: boolean` - `source: BetaBase64PDFSource | BetaPlainTextSource` - `BetaBase64PDFSource` - `data: string` - `media_type: "application/pdf"` - `"application/pdf"` - `type: "base64"` - `"base64"` - `BetaPlainTextSource` - `data: string` - `media_type: "text/plain"` - `"text/plain"` - `type: "text"` - `"text"` - `title: string | null` The title of the document - `type: "document"` - `"document"` - `retrieved_at: string | null` ISO 8601 timestamp when the content was retrieved - `type: "web_fetch_result"` - `"web_fetch_result"` - `url: string` Fetched content URL ### Beta Web Fetch Block Param - `BetaWebFetchBlockParam` - `content: BetaRequestDocumentBlock` - `source: BetaBase64PDFSource | BetaPlainTextSource | BetaContentBlockSource | 2 more` - `BetaBase64PDFSource` - `data: string` - `media_type: "application/pdf"` - `"application/pdf"` - `type: "base64"` - `"base64"` - `BetaPlainTextSource` - `data: string` - `media_type: "text/plain"` - `"text/plain"` - `type: "text"` - `"text"` - `BetaContentBlockSource` - `content: string | Array` - `string` - `Array` - `BetaTextBlockParam` - `text: string` - `type: "text"` - `"text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `citations?: Array | null` - `BetaCitationCharLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `BetaCitationContentBlockLocationParam` - `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 | null` - `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`. - `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"` - `BetaCitationWebSearchResultLocationParam` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `BetaCitationSearchResultLocationParam` - `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 | null` - `type: "search_result_location"` - `"search_result_location"` - `BetaImageBlockParam` - `source: BetaBase64ImageSource | BetaURLImageSource | BetaFileImageSource` - `BetaBase64ImageSource` - `data: string` - `media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `type: "base64"` - `"base64"` - `BetaURLImageSource` - `type: "url"` - `"url"` - `url: string` - `BetaFileImageSource` - `file_id: string` - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "content"` - `"content"` - `BetaURLPDFSource` - `type: "url"` - `"url"` - `url: string` - `BetaFileDocumentSource` - `file_id: string` - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam | null` - `enabled?: boolean` - `context?: string | null` - `title?: string | null` - `type: "web_fetch_result"` - `"web_fetch_result"` - `url: string` Fetched content URL - `retrieved_at?: string | null` ISO 8601 timestamp when the content was retrieved ### Beta Web Fetch Tool 20250910 - `BetaWebFetchTool20250910` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"web_fetch"` - `type: "web_fetch_20250910"` - `"web_fetch_20250910"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `citations?: BetaCitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `enabled?: boolean` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Beta Web Fetch Tool 20260209 - `BetaWebFetchTool20260209` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"web_fetch"` - `type: "web_fetch_20260209"` - `"web_fetch_20260209"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `citations?: BetaCitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `enabled?: boolean` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Beta Web Fetch Tool 20260309 - `BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"web_fetch"` - `type: "web_fetch_20260309"` - `"web_fetch_20260309"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `citations?: BetaCitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `enabled?: boolean` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `use_cache?: boolean` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. ### Beta Web Fetch Tool Result Block - `BetaWebFetchToolResultBlock` - `content: BetaWebFetchToolResultErrorBlock | BetaWebFetchBlock` - `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"` - `BetaWebFetchBlock` - `content: BetaDocumentBlock` - `citations: BetaCitationConfig | null` Citation configuration for the document - `enabled: boolean` - `source: BetaBase64PDFSource | BetaPlainTextSource` - `BetaBase64PDFSource` - `data: string` - `media_type: "application/pdf"` - `"application/pdf"` - `type: "base64"` - `"base64"` - `BetaPlainTextSource` - `data: string` - `media_type: "text/plain"` - `"text/plain"` - `type: "text"` - `"text"` - `title: string | null` The title of the document - `type: "document"` - `"document"` - `retrieved_at: string | null` 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. - `BetaDirectCaller` Tool invocation directly from the model. - `type: "direct"` - `"direct"` - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `BetaServerToolCaller20260120` - `tool_id: string` - `type: "code_execution_20260120"` - `"code_execution_20260120"` ### Beta Web Fetch Tool Result Block Param - `BetaWebFetchToolResultBlockParam` - `content: BetaWebFetchToolResultErrorBlockParam | BetaWebFetchBlockParam` - `BetaWebFetchToolResultErrorBlockParam` - `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"` - `BetaWebFetchBlockParam` - `content: BetaRequestDocumentBlock` - `source: BetaBase64PDFSource | BetaPlainTextSource | BetaContentBlockSource | 2 more` - `BetaBase64PDFSource` - `data: string` - `media_type: "application/pdf"` - `"application/pdf"` - `type: "base64"` - `"base64"` - `BetaPlainTextSource` - `data: string` - `media_type: "text/plain"` - `"text/plain"` - `type: "text"` - `"text"` - `BetaContentBlockSource` - `content: string | Array` - `string` - `Array` - `BetaTextBlockParam` - `text: string` - `type: "text"` - `"text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `citations?: Array | null` - `BetaCitationCharLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `BetaCitationContentBlockLocationParam` - `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 | null` - `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`. - `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"` - `BetaCitationWebSearchResultLocationParam` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `BetaCitationSearchResultLocationParam` - `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 | null` - `type: "search_result_location"` - `"search_result_location"` - `BetaImageBlockParam` - `source: BetaBase64ImageSource | BetaURLImageSource | BetaFileImageSource` - `BetaBase64ImageSource` - `data: string` - `media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `type: "base64"` - `"base64"` - `BetaURLImageSource` - `type: "url"` - `"url"` - `url: string` - `BetaFileImageSource` - `file_id: string` - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "content"` - `"content"` - `BetaURLPDFSource` - `type: "url"` - `"url"` - `url: string` - `BetaFileDocumentSource` - `file_id: string` - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam | null` - `enabled?: boolean` - `context?: string | null` - `title?: string | null` - `type: "web_fetch_result"` - `"web_fetch_result"` - `url: string` Fetched content URL - `retrieved_at?: string | null` ISO 8601 timestamp when the content was retrieved - `tool_use_id: string` - `type: "web_fetch_tool_result"` - `"web_fetch_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `type: "direct"` - `"direct"` - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `BetaServerToolCaller20260120` - `tool_id: string` - `type: "code_execution_20260120"` - `"code_execution_20260120"` ### Beta Web Fetch Tool Result Error Block - `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"` ### Beta Web Fetch Tool Result Error Block Param - `BetaWebFetchToolResultErrorBlockParam` - `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"` ### Beta Web Fetch Tool Result Error Code - `BetaWebFetchToolResultErrorCode = "invalid_tool_input" | "url_too_long" | "url_not_allowed" | 6 more` - `"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"` ### Beta Web Search Result Block - `BetaWebSearchResultBlock` - `encrypted_content: string` - `page_age: string | null` - `title: string` - `type: "web_search_result"` - `"web_search_result"` - `url: string` ### Beta Web Search Result Block Param - `BetaWebSearchResultBlockParam` - `encrypted_content: string` - `title: string` - `type: "web_search_result"` - `"web_search_result"` - `url: string` - `page_age?: string | null` ### Beta Web Search Tool 20250305 - `BetaWebSearchTool20250305` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"web_search"` - `type: "web_search_20250305"` - `"web_search_20250305"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: BetaUserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `type: "approximate"` - `"approximate"` - `city?: string | null` The city of the user. - `country?: string | null` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. - `region?: string | null` The region of the user. - `timezone?: string | null` The [IANA timezone](https://nodatime.org/TimeZones) of the user. ### Beta Web Search Tool 20260209 - `BetaWebSearchTool20260209` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"web_search"` - `type: "web_search_20260209"` - `"web_search_20260209"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: BetaUserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `type: "approximate"` - `"approximate"` - `city?: string | null` The city of the user. - `country?: string | null` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. - `region?: string | null` The region of the user. - `timezone?: string | null` The [IANA timezone](https://nodatime.org/TimeZones) of the user. ### Beta Web Search Tool Request Error - `BetaWebSearchToolRequestError` - `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"` ### Beta Web Search Tool Result Block - `BetaWebSearchToolResultBlock` - `content: BetaWebSearchToolResultBlockContent` - `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"` - `Array` - `encrypted_content: string` - `page_age: string | null` - `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. - `BetaDirectCaller` Tool invocation directly from the model. - `type: "direct"` - `"direct"` - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `BetaServerToolCaller20260120` - `tool_id: string` - `type: "code_execution_20260120"` - `"code_execution_20260120"` ### Beta Web Search Tool Result Block Content - `BetaWebSearchToolResultBlockContent = BetaWebSearchToolResultError | Array` - `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"` - `Array` - `encrypted_content: string` - `page_age: string | null` - `title: string` - `type: "web_search_result"` - `"web_search_result"` - `url: string` ### Beta Web Search Tool Result Block Param - `BetaWebSearchToolResultBlockParam` - `content: BetaWebSearchToolResultBlockParamContent` - `Array` - `encrypted_content: string` - `title: string` - `type: "web_search_result"` - `"web_search_result"` - `url: string` - `page_age?: string | null` - `BetaWebSearchToolRequestError` - `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"` - `tool_use_id: string` - `type: "web_search_tool_result"` - `"web_search_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `type: "direct"` - `"direct"` - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `BetaServerToolCaller20260120` - `tool_id: string` - `type: "code_execution_20260120"` - `"code_execution_20260120"` ### Beta Web Search Tool Result Block Param Content - `BetaWebSearchToolResultBlockParamContent = Array | BetaWebSearchToolRequestError` - `Array` - `encrypted_content: string` - `title: string` - `type: "web_search_result"` - `"web_search_result"` - `url: string` - `page_age?: string | null` - `BetaWebSearchToolRequestError` - `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"` ### Beta Web Search Tool Result Error - `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"` ### Beta Web Search Tool Result Error Code - `BetaWebSearchToolResultErrorCode = "invalid_tool_input" | "unavailable" | "max_uses_exceeded" | 3 more` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` # Batches ## Create a Message Batch `client.beta.messages.batches.create(BatchCreateParamsparams, RequestOptionsoptions?): BetaMessageBatch` **post** `/v1/messages/batches` Send a batch of Message creation requests. The Message Batches API can be used to process multiple Messages API requests at once. Once a Message Batch is created, it begins processing immediately. Batches can take up to 24 hours to complete. Learn more about the Message Batches API in our [user guide](https://docs.claude.com/en/docs/build-with-claude/batch-processing) ### Parameters - `params: BatchCreateParams` - `requests: Array` Body param: List of requests for prompt completion. Each is an individual request to create a Message. - `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. - `params: Params` Messages API creation parameters for the individual request. See the [Messages API reference](https://docs.claude.com/en/api/messages) for full documentation on available parameters. - `max_tokens: number` The maximum number of tokens to generate before stopping. Note that our models may stop _before_ reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate. Set to `0` to populate the [prompt cache](https://docs.claude.com/en/docs/build-with-claude/prompt-caching#pre-warming-the-cache) without generating a response. Different models have different maximum values for this parameter. See [models](https://docs.claude.com/en/docs/models-overview) for details. - `messages: Array` Input messages. Our models are trained to operate on alternating `user` and `assistant` conversational turns. When creating a new `Message`, you specify the prior conversational turns with the `messages` parameter, and the model then generates the next `Message` in the conversation. Consecutive `user` or `assistant` turns in your request will be combined into a single turn. Each input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages. If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. Example with a single `user` message: ```json [{"role": "user", "content": "Hello, Claude"}] ``` Example with multiple conversational turns: ```json [ {"role": "user", "content": "Hello there."}, {"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"}, {"role": "user", "content": "Can you explain LLMs in plain English?"}, ] ``` Example with a partially-filled response from Claude: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("}, ] ``` Each input message `content` may be either a single `string` or an array of content blocks, where each block has a specific `type`. Using a `string` for `content` is shorthand for an array of one content block of type `"text"`. The following input messages are equivalent: ```json {"role": "user", "content": "Hello, Claude"} ``` ```json {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]} ``` See [input examples](https://docs.claude.com/en/api/messages-examples). Note that if you want to include a [system prompt](https://docs.claude.com/en/docs/system-prompts), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API. There is a limit of 100,000 messages in a single request. - `content: string | Array` - `string` - `Array` - `BetaTextBlockParam` - `text: string` - `type: "text"` - `"text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `"ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `"5m"` - `"1h"` - `citations?: Array | null` - `BetaCitationCharLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocationParam` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `BetaCitationContentBlockLocationParam` - `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 | null` - `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`. - `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"` - `BetaCitationWebSearchResultLocationParam` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `BetaCitationSearchResultLocationParam` - `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 | null` - `type: "search_result_location"` - `"search_result_location"` - `BetaImageBlockParam` - `source: BetaBase64ImageSource | BetaURLImageSource | BetaFileImageSource` - `BetaBase64ImageSource` - `data: string` - `media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `type: "base64"` - `"base64"` - `BetaURLImageSource` - `type: "url"` - `"url"` - `url: string` - `BetaFileImageSource` - `file_id: string` - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaRequestDocumentBlock` - `source: BetaBase64PDFSource | BetaPlainTextSource | BetaContentBlockSource | 2 more` - `BetaBase64PDFSource` - `data: string` - `media_type: "application/pdf"` - `"application/pdf"` - `type: "base64"` - `"base64"` - `BetaPlainTextSource` - `data: string` - `media_type: "text/plain"` - `"text/plain"` - `type: "text"` - `"text"` - `BetaContentBlockSource` - `content: string | Array` - `string` - `Array` - `BetaTextBlockParam` - `BetaImageBlockParam` - `type: "content"` - `"content"` - `BetaURLPDFSource` - `type: "url"` - `"url"` - `url: string` - `BetaFileDocumentSource` - `file_id: string` - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam | null` - `enabled?: boolean` - `context?: string | null` - `title?: string | null` - `BetaSearchResultBlockParam` - `content: Array` - `text: string` - `type: "text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `source: string` - `title: string` - `type: "search_result"` - `"search_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam` - `BetaThinkingBlockParam` - `signature: string` - `thinking: string` - `type: "thinking"` - `"thinking"` - `BetaRedactedThinkingBlockParam` - `data: string` - `type: "redacted_thinking"` - `"redacted_thinking"` - `BetaToolUseBlockParam` - `id: string` - `input: Record` - `name: string` - `type: "tool_use"` - `"tool_use"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `type: "direct"` - `"direct"` - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `BetaServerToolCaller20260120` - `tool_id: string` - `type: "code_execution_20260120"` - `"code_execution_20260120"` - `BetaToolResultBlockParam` - `tool_use_id: string` - `type: "tool_result"` - `"tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `content?: string | Array` - `string` - `Array` - `BetaTextBlockParam` - `BetaImageBlockParam` - `BetaSearchResultBlockParam` - `BetaRequestDocumentBlock` - `BetaToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `tool_name: string` - `type: "tool_reference"` - `"tool_reference"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `is_error?: boolean` - `BetaServerToolUseBlockParam` - `id: string` - `input: Record` - `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"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebSearchToolResultBlockParam` - `content: BetaWebSearchToolResultBlockParamContent` - `Array` - `encrypted_content: string` - `title: string` - `type: "web_search_result"` - `"web_search_result"` - `url: string` - `page_age?: string | null` - `BetaWebSearchToolRequestError` - `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"` - `tool_use_id: string` - `type: "web_search_tool_result"` - `"web_search_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebFetchToolResultBlockParam` - `content: BetaWebFetchToolResultErrorBlockParam | BetaWebFetchBlockParam` - `BetaWebFetchToolResultErrorBlockParam` - `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"` - `BetaWebFetchBlockParam` - `content: BetaRequestDocumentBlock` - `type: "web_fetch_result"` - `"web_fetch_result"` - `url: string` Fetched content URL - `retrieved_at?: string | null` ISO 8601 timestamp when the content was retrieved - `tool_use_id: string` - `type: "web_fetch_tool_result"` - `"web_fetch_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaAdvisorToolResultBlockParam` - `content: BetaAdvisorToolResultErrorParam | BetaAdvisorResultBlockParam | BetaAdvisorRedactedResultBlockParam` - `BetaAdvisorToolResultErrorParam` - `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"` - `BetaAdvisorResultBlockParam` - `text: string` - `type: "advisor_result"` - `"advisor_result"` - `stop_reason?: string | null` - `BetaAdvisorRedactedResultBlockParam` - `encrypted_content: string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `type: "advisor_redacted_result"` - `"advisor_redacted_result"` - `stop_reason?: string | null` - `tool_use_id: string` - `type: "advisor_tool_result"` - `"advisor_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaCodeExecutionToolResultBlockParam` - `content: BetaCodeExecutionToolResultBlockParamContent` Code execution result with encrypted stdout for PFC + web_search results. - `BetaCodeExecutionToolResultErrorParam` - `error_code: BetaCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `type: "code_execution_tool_result_error"` - `"code_execution_tool_result_error"` - `BetaCodeExecutionResultBlockParam` - `content: Array` - `file_id: string` - `type: "code_execution_output"` - `"code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "code_execution_result"` - `"code_execution_result"` - `BetaEncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `content: Array` - `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"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaBashCodeExecutionToolResultBlockParam` - `content: BetaBashCodeExecutionToolResultErrorParam | BetaBashCodeExecutionResultBlockParam` - `BetaBashCodeExecutionToolResultErrorParam` - `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"` - `BetaBashCodeExecutionResultBlockParam` - `content: Array` - `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"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaTextEditorCodeExecutionToolResultBlockParam` - `content: BetaTextEditorCodeExecutionToolResultErrorParam | BetaTextEditorCodeExecutionViewResultBlockParam | BetaTextEditorCodeExecutionCreateResultBlockParam | BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `BetaTextEditorCodeExecutionToolResultErrorParam` - `error_code: "invalid_tool_input" | "unavailable" | "too_many_requests" | 2 more` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `type: "text_editor_code_execution_tool_result_error"` - `"text_editor_code_execution_tool_result_error"` - `error_message?: string | null` - `BetaTextEditorCodeExecutionViewResultBlockParam` - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `type: "text_editor_code_execution_view_result"` - `"text_editor_code_execution_view_result"` - `num_lines?: number | null` - `start_line?: number | null` - `total_lines?: number | null` - `BetaTextEditorCodeExecutionCreateResultBlockParam` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `"text_editor_code_execution_create_result"` - `BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `type: "text_editor_code_execution_str_replace_result"` - `"text_editor_code_execution_str_replace_result"` - `lines?: Array | null` - `new_lines?: number | null` - `new_start?: number | null` - `old_lines?: number | null` - `old_start?: number | null` - `tool_use_id: string` - `type: "text_editor_code_execution_tool_result"` - `"text_editor_code_execution_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaToolSearchToolResultBlockParam` - `content: BetaToolSearchToolResultErrorParam | BetaToolSearchToolSearchResultBlockParam` - `BetaToolSearchToolResultErrorParam` - `error_code: "invalid_tool_input" | "unavailable" | "too_many_requests" | "execution_time_exceeded"` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `type: "tool_search_tool_result_error"` - `"tool_search_tool_result_error"` - `error_message?: string | null` - `BetaToolSearchToolSearchResultBlockParam` - `tool_references: Array` - `tool_name: string` - `type: "tool_reference"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "tool_search_tool_search_result"` - `"tool_search_tool_search_result"` - `tool_use_id: string` - `type: "tool_search_tool_result"` - `"tool_search_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaMCPToolUseBlockParam` - `id: string` - `input: Record` - `name: string` - `server_name: string` The name of the MCP server - `type: "mcp_tool_use"` - `"mcp_tool_use"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaRequestMCPToolResultBlockParam` - `tool_use_id: string` - `type: "mcp_tool_result"` - `"mcp_tool_result"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `content?: string | Array` - `string` - `Array` - `text: string` - `type: "text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `is_error?: boolean` - `BetaContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `file_id: string` - `type: "container_upload"` - `"container_upload"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaCompactionBlockParam` A compaction block containing summary of previous context. Users should round-trip these blocks from responses to subsequent requests to maintain context across compaction boundaries. When content is None, the block represents a failed compaction. The server treats these as no-ops. Empty string content is not allowed. - `type: "compaction"` - `"compaction"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `content?: string | null` Summary of previously compacted content, or null if compaction failed - `encrypted_content?: string | null` Opaque metadata from prior compaction, to be round-tripped verbatim - `BetaMidConversationSystemBlockParam` System instructions that appear mid-conversation. Use this block to provide or update system-level instructions at a specific point in the conversation, rather than only via the top-level `system` parameter. - `content: Array` System instruction text blocks. - `text: string` - `type: "text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `type: "mid_conv_system"` - `"mid_conv_system"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `BetaFallbackBlockParam` A `fallback` block echoed back from a prior response. Accepted in `messages[].content` and never rendered into the prompt, not validated against the request's `fallbacks` chain or top-level `model`, and stripped before the sticky-routing cache key is computed. Callers should echo the assistant turn verbatim — block included. The block's position is load-bearing for thinking verification: the thinking runs on either side of a fallback hop carry independently-rooted verification hash chains, and this block is the only record of where one chain ends and the next begins. When thinking runs flank the boundary, omitting the block merges the runs into one contiguous span whose hashes cannot verify (the request is rejected), and moving it into the middle of a single run splits that run's chain and is likewise rejected; between non-thinking blocks the block's placement has no verification effect. - `from: BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `model: Model` 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" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` - `to: BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `type: "fallback"` - `"fallback"` - `role: "user" | "assistant" | "system"` - `"user"` - `"assistant"` - `"system"` - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `cache_control?: BetaCacheControlEphemeral | null` Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request. - `container?: BetaContainerParams | string | null` Container identifier for reuse across requests. - `BetaContainerParams` Container parameters with skills to be loaded. - `id?: string | null` Container id - `skills?: Array | null` List of skills to load 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 - `string` - `context_management?: BetaContextManagementConfig | null` Context management configuration. This allows you to control how Claude manages context across multiple requests, such as whether to clear function results or not. - `edits?: Array` List of context management edits to apply - `BetaClearToolUses20250919Edit` - `type: "clear_tool_uses_20250919"` - `"clear_tool_uses_20250919"` - `clear_at_least?: BetaInputTokensClearAtLeast | null` Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed. - `type: "input_tokens"` - `"input_tokens"` - `value: number` - `clear_tool_inputs?: boolean | Array | null` Whether to clear all tool inputs (bool) or specific tool inputs to clear (list) - `boolean` - `Array` - `exclude_tools?: Array | null` Tool names whose uses are preserved from clearing - `keep?: BetaToolUsesKeep` Number of tool uses to retain in the conversation - `type: "tool_uses"` - `"tool_uses"` - `value: number` - `trigger?: BetaInputTokensTrigger | BetaToolUsesTrigger` Condition that triggers the context management strategy - `BetaInputTokensTrigger` - `type: "input_tokens"` - `"input_tokens"` - `value: number` - `BetaToolUsesTrigger` - `type: "tool_uses"` - `"tool_uses"` - `value: number` - `BetaClearThinking20251015Edit` - `type: "clear_thinking_20251015"` - `"clear_thinking_20251015"` - `keep?: BetaThinkingTurns | BetaAllThinkingTurns | "all"` Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed. - `BetaThinkingTurns` - `type: "thinking_turns"` - `"thinking_turns"` - `value: number` - `BetaAllThinkingTurns` - `type: "all"` - `"all"` - `"all"` - `"all"` - `BetaCompact20260112Edit` Automatically compact older context when reaching the configured trigger threshold. - `type: "compact_20260112"` - `"compact_20260112"` - `instructions?: string | null` Additional instructions for summarization. - `pause_after_compaction?: boolean` Whether to pause after compaction and return the compaction block to the user. - `trigger?: BetaInputTokensTrigger | null` When to trigger compaction. Defaults to 150000 input tokens. - `diagnostics?: BetaDiagnosticsParam | null` Request-level diagnostics. Currently carries the previous response id for prompt-cache divergence reporting. - `previous_message_id?: string | null` The `id` (`msg_...`) from this client's previous /v1/messages response. The server compares that request's prompt fingerprint against this one and returns `diagnostics.cache_miss_reason` when the prompt-cache prefix could not be reused. Pass `null` on the first turn to opt in without a prior message to compare. - `fallback_credit_token?: string | null` The `fallback_credit_token` from a prior refusal's `stop_details`. When a preceding request was refused and returned a `fallback_credit_token`, pass that code here on the retry to have the retry's cache-creation tokens for the prefix that was warm on the refused model billed at the cache-read rate. Must be redeemed by the same organization and workspace, with the same request body (optionally extended by 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 streamed before the refusal; the appended-assistant form is not available for requests with `output_format` set or forced `tool_choice`), on an eligible fallback model, on the same platform, and within 5 minutes of the refusal; a mismatch is a 400. A token minted mid-server-tool-loop whose partial content was continuable may only be redeemed with the appended-assistant form — if an exact-body retry is rejected with a 400 saying the token must be redeemed by continuing the partial response, retry with the appended-assistant form instead. When the appended-assistant form is used on a model that otherwise disallows assistant-turn prefill, this token also authorizes that one prefill. - `fallbacks?: Array | null` Opt-in server-side retry on one or more substitute models when the requested model declines for policy reasons. Tried in order: if the first entry also declines, the second is tried, and so on. - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `max_tokens?: number | null` - `output_config?: BetaOutputConfig | null` - `effort?: "low" | "medium" | "high" | 2 more | null` All possible effort levels. - `"low"` - `"medium"` - `"high"` - `"xhigh"` - `"max"` - `format?: BetaJSONOutputFormat | null` A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) - `schema: Record` The JSON schema of the format - `type: "json_schema"` - `"json_schema"` - `task_budget?: BetaTokenTaskBudget | null` User-configurable total token budget across contexts. - `total: number` Total token budget across all contexts in the session. - `type: "tokens"` The budget type. Currently only 'tokens' is supported. - `"tokens"` - `remaining?: number | null` Remaining tokens in the budget. Use this to track usage across contexts when implementing compaction client-side. Defaults to total if not provided. - `speed?: "standard" | "fast" | null` - `"standard"` - `"fast"` - `thinking?: BetaThinkingConfigEnabled | BetaThinkingConfigDisabled | BetaThinkingConfigAdaptive | null` - `BetaThinkingConfigEnabled` - `budget_tokens: number` Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality. Must be ≥1024 and less than `max_tokens`. See [extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details. - `type: "enabled"` - `"enabled"` - `display?: "summarized" | "omitted" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. - `"summarized"` - `"omitted"` - `BetaThinkingConfigDisabled` - `type: "disabled"` - `"disabled"` - `BetaThinkingConfigAdaptive` - `type: "adaptive"` - `"adaptive"` - `display?: "summarized" | "omitted" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. - `"summarized"` - `"omitted"` - `inference_geo?: string | null` Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used. - `mcp_servers?: Array` MCP servers to be utilized in this request - `name: string` - `type: "url"` - `"url"` - `url: string` - `authorization_token?: string | null` - `tool_configuration?: BetaRequestMCPServerToolConfiguration | null` - `allowed_tools?: Array | null` - `enabled?: boolean | null` - `metadata?: BetaMetadata` An object describing metadata about the request. - `user_id?: string | null` An external identifier for the user who is associated with the request. This should be a uuid, hash value, or other opaque identifier. Anthropic may use this id to help detect abuse. Do not include any identifying information such as name, email address, or phone number. - `output_config?: BetaOutputConfig` Configuration options for the model's output, such as the output format. - `output_format?: BetaJSONOutputFormat | null` Deprecated: Use `output_config.format` instead. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) A schema to specify Claude's output format in responses. This parameter will be removed in a future release. - `service_tier?: "auto" | "standard_only"` Determines whether to use priority capacity (if available) or standard capacity for this request. Anthropic offers different levels of service for your API requests. See [service-tiers](https://docs.claude.com/en/api/service-tiers) for details. - `"auto"` - `"standard_only"` - `speed?: "standard" | "fast" | null` The inference speed mode for this request. `"fast"` enables high output-tokens-per-second inference. - `"standard"` - `"fast"` - `stop_sequences?: Array` Custom text sequences that will cause the model to stop generating. Our models will normally stop when they have naturally completed their turn, which will result in a response `stop_reason` of `"end_turn"`. If you want the model to stop generating when it encounters custom strings of text, you can use the `stop_sequences` parameter. If the model encounters one of the custom sequences, the response `stop_reason` value will be `"stop_sequence"` and the response `stop_sequence` value will contain the matched stop sequence. - `stream?: boolean` Whether to incrementally stream the response using server-sent events. See [streaming](https://docs.claude.com/en/api/messages-streaming) for details. - `system?: string | Array` System prompt. A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://docs.claude.com/en/docs/system-prompts). - `string` - `Array` - `text: string` - `type: "text"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `temperature?: number` Amount of randomness injected into the response. Defaults to `1.0`. Ranges from `0.0` to `1.0`. Use `temperature` closer to `0.0` for analytical / multiple choice, and closer to `1.0` for creative and generative tasks. Note that even with `temperature` of `0.0`, the results will not be fully deterministic. - `thinking?: BetaThinkingConfigParam` Configuration for enabling Claude's extended thinking. When enabled, responses include `thinking` content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your `max_tokens` limit. See [extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details. - `BetaThinkingConfigEnabled` - `BetaThinkingConfigDisabled` - `BetaThinkingConfigAdaptive` - `tool_choice?: BetaToolChoice` How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. - `BetaToolChoiceAuto` The model will automatically decide whether to use tools. - `type: "auto"` - `"auto"` - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output at most one tool use. - `BetaToolChoiceAny` The model will use any available tools. - `type: "any"` - `"any"` - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `BetaToolChoiceTool` The model will use the specified tool with `tool_choice.name`. - `name: string` The name of the tool to use. - `type: "tool"` - `"tool"` - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `BetaToolChoiceNone` The model will not be allowed to use tools. - `type: "none"` - `"none"` - `tools?: Array` Definitions of tools that the model may use. If you include `tools` in your API request, the model may return `tool_use` content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using `tool_result` content blocks. There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://docs.claude.com/en/docs/agents-and-tools/tool-use/overview#server-tools), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://docs.claude.com/en/docs/agents-and-tools/tool-use/web-search-tool)). Each tool definition includes: * `name`: Name of the tool. * `description`: Optional, but strongly-recommended description of the tool. * `input_schema`: [JSON schema](https://json-schema.org/draft/2020-12) for the tool `input` shape that the model will produce in `tool_use` output content blocks. For example, if you defined `tools` as: ```json [ { "name": "get_stock_price", "description": "Get the current stock price for a given ticker symbol.", "input_schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "The stock ticker symbol, e.g. AAPL for Apple Inc." } }, "required": ["ticker"] } } ] ``` And then asked the model "What's the S&P 500 at today?", the model might produce `tool_use` content blocks in the response like this: ```json [ { "type": "tool_use", "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "name": "get_stock_price", "input": { "ticker": "^GSPC" } } ] ``` You might then run your `get_stock_price` tool with `{"ticker": "^GSPC"}` as an input, and return the following back to the model in a subsequent `user` message: ```json [ { "type": "tool_result", "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "content": "259.75 USD" } ] ``` Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output. See our [guide](https://docs.claude.com/en/docs/tool-use) for more details. - `BetaTool` - `input_schema: InputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `type: "object"` - `"object"` - `properties?: Record | null` - `required?: Array | null` - `name: string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `description?: string` Description of what this tool does. Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema. - `eager_input_streaming?: boolean | null` Enable eager input streaming for this tool. When true, tool input parameters will be streamed incrementally as they are generated, and types will be inferred on-the-fly rather than buffering the full JSON output. When false, streaming is disabled for this tool even if the fine-grained-tool-streaming beta is active. When null (default), uses the default behavior based on beta headers. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `type?: "custom" | null` - `"custom"` - `BetaToolBash20241022` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"bash"` - `type: "bash_20241022"` - `"bash_20241022"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolBash20250124` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"bash"` - `type: "bash_20250124"` - `"bash_20250124"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20250522` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"code_execution"` - `type: "code_execution_20250522"` - `"code_execution_20250522"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20250825` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"code_execution"` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"code_execution"` - `type: "code_execution_20260120"` - `"code_execution_20260120"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolComputerUse20241022` - `display_height_px: number` The height of the display in pixels. - `display_width_px: number` The width of the display in pixels. - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"computer"` - `type: "computer_20241022"` - `"computer_20241022"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number?: number | null` The X11 display number (e.g. 0, 1) for the display. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaMemoryTool20250818` - `name: "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"memory"` - `type: "memory_20250818"` - `"memory_20250818"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolComputerUse20250124` - `display_height_px: number` The height of the display in pixels. - `display_width_px: number` The width of the display in pixels. - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"computer"` - `type: "computer_20250124"` - `"computer_20250124"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number?: number | null` The X11 display number (e.g. 0, 1) for the display. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20241022` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"str_replace_editor"` - `type: "text_editor_20241022"` - `"text_editor_20241022"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolComputerUse20251124` - `display_height_px: number` The height of the display in pixels. - `display_width_px: number` The width of the display in pixels. - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"computer"` - `type: "computer_20251124"` - `"computer_20251124"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number?: number | null` The X11 display number (e.g. 0, 1) for the display. - `enable_zoom?: boolean` Whether to enable an action to take a zoomed-in screenshot of the screen. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20250124` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"str_replace_editor"` - `type: "text_editor_20250124"` - `"text_editor_20250124"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20250429` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"str_replace_based_edit_tool"` - `type: "text_editor_20250429"` - `"text_editor_20250429"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20250728` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"str_replace_based_edit_tool"` - `type: "text_editor_20250728"` - `"text_editor_20250728"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `max_characters?: number | null` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaWebSearchTool20250305` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"web_search"` - `type: "web_search_20250305"` - `"web_search_20250305"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: BetaUserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `type: "approximate"` - `"approximate"` - `city?: string | null` The city of the user. - `country?: string | null` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. - `region?: string | null` The region of the user. - `timezone?: string | null` The [IANA timezone](https://nodatime.org/TimeZones) of the user. - `BetaWebFetchTool20250910` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"web_fetch"` - `type: "web_fetch_20250910"` - `"web_fetch_20250910"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaWebSearchTool20260209` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"web_search"` - `type: "web_search_20260209"` - `"web_search_20260209"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: BetaUserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `BetaWebFetchTool20260209` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"web_fetch"` - `type: "web_fetch_20260209"` - `"web_fetch_20260209"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"web_fetch"` - `type: "web_fetch_20260309"` - `"web_fetch_20260309"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: BetaCitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `use_cache?: boolean` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `BetaAdvisorTool20260301` - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `name: "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"advisor"` - `type: "advisor_20260301"` - `"advisor_20260301"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caching?: BetaCacheControlEphemeral | null` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_tokens?: number | null` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolSearchToolBm25_20251119` - `name: "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"tool_search_tool_bm25"` - `type: "tool_search_tool_bm25_20251119" | "tool_search_tool_bm25"` - `"tool_search_tool_bm25_20251119"` - `"tool_search_tool_bm25"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolSearchToolRegex20251119` - `name: "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `"tool_search_tool_regex"` - `type: "tool_search_tool_regex_20251119" | "tool_search_tool_regex"` - `"tool_search_tool_regex_20251119"` - `"tool_search_tool_regex"` - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `mcp_server_name: string` Name of the MCP server to configure tools for - `type: "mcp_toolset"` - `"mcp_toolset"` - `cache_control?: BetaCacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `configs?: Record | null` Configuration overrides for specific tools, keyed by tool name - `defer_loading?: boolean` - `enabled?: boolean` - `default_config?: BetaMCPToolDefaultConfig` Default configuration applied to all tools from this server - `defer_loading?: boolean` - `enabled?: boolean` - `top_k?: number` Only sample from the top K options for each subsequent token. Used to remove "long tail" low probability responses. [Learn more technical details here](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277). Recommended for advanced use cases only. - `top_p?: number` Use nucleus sampling. In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by `top_p`. Recommended for advanced use cases only. - `user_profile_id?: string | null` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. - `betas?: Array` Header param: Optional header to specify the beta version(s) you want to use. - `(string & {})` - `"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 - `BetaMessageBatch` - `id: string` Unique object identifier. The format and length of IDs may change over time. - `archived_at: string | null` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. - `cancel_initiated_at: string | null` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. - `created_at: string` RFC 3339 datetime string representing the time at which the Message Batch was created. - `ended_at: string | null` RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends. Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired. - `expires_at: string` RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. - `processing_status: "in_progress" | "canceling" | "ended"` Processing status of the Message Batch. - `"in_progress"` - `"canceling"` - `"ended"` - `request_counts: BetaMessageBatchRequestCounts` Tallies requests within the Message Batch, categorized by their status. Requests start as `processing` and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch. - `canceled: number` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. - `errored: number` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. - `expired: number` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. - `processing: number` Number of requests in the Message Batch that are processing. - `succeeded: number` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. - `results_url: string | null` URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. - `type: "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. - `"message_batch"` ### Example ```typescript import Anthropic from '@anthropic-ai/sdk'; const client = new Anthropic({ apiKey: process.env['ANTHROPIC_API_KEY'], // This is the default and can be omitted }); const betaMessageBatch = await client.beta.messages.batches.create({ requests: [ { custom_id: 'my-custom-id-1', params: { max_tokens: 1024, messages: [{ content: 'Hello, world', role: 'user' }], model: 'claude-opus-4-6', }, }, ], }); console.log(betaMessageBatch.id); ``` #### Response ```json { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } ``` ## Retrieve a Message Batch `client.beta.messages.batches.retrieve(stringmessageBatchID, BatchRetrieveParamsparams?, RequestOptionsoptions?): BetaMessageBatch` **get** `/v1/messages/batches/{message_batch_id}` This endpoint is idempotent and can be used to poll for Message Batch completion. To access the results of a Message Batch, make a request to the `results_url` field in the response. Learn more about the Message Batches API in our [user guide](https://docs.claude.com/en/docs/build-with-claude/batch-processing) ### Parameters - `messageBatchID: string` ID of the Message Batch. - `params: BatchRetrieveParams` - `betas?: Array` Optional header to specify the beta version(s) you want to use. - `(string & {})` - `"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 - `BetaMessageBatch` - `id: string` Unique object identifier. The format and length of IDs may change over time. - `archived_at: string | null` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. - `cancel_initiated_at: string | null` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. - `created_at: string` RFC 3339 datetime string representing the time at which the Message Batch was created. - `ended_at: string | null` RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends. Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired. - `expires_at: string` RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. - `processing_status: "in_progress" | "canceling" | "ended"` Processing status of the Message Batch. - `"in_progress"` - `"canceling"` - `"ended"` - `request_counts: BetaMessageBatchRequestCounts` Tallies requests within the Message Batch, categorized by their status. Requests start as `processing` and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch. - `canceled: number` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. - `errored: number` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. - `expired: number` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. - `processing: number` Number of requests in the Message Batch that are processing. - `succeeded: number` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. - `results_url: string | null` URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. - `type: "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. - `"message_batch"` ### Example ```typescript import Anthropic from '@anthropic-ai/sdk'; const client = new Anthropic({ apiKey: process.env['ANTHROPIC_API_KEY'], // This is the default and can be omitted }); const betaMessageBatch = await client.beta.messages.batches.retrieve('message_batch_id'); console.log(betaMessageBatch.id); ``` #### Response ```json { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } ``` ## List Message Batches `client.beta.messages.batches.list(BatchListParamsparams?, RequestOptionsoptions?): Page` **get** `/v1/messages/batches` List all Message Batches within a Workspace. Most recently created batches are returned first. Learn more about the Message Batches API in our [user guide](https://docs.claude.com/en/docs/build-with-claude/batch-processing) ### Parameters - `params: BatchListParams` - `after_id?: string` Query param: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. - `before_id?: string` Query param: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. - `limit?: number` Query param: Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. - `betas?: Array` Header param: Optional header to specify the beta version(s) you want to use. - `(string & {})` - `"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 - `BetaMessageBatch` - `id: string` Unique object identifier. The format and length of IDs may change over time. - `archived_at: string | null` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. - `cancel_initiated_at: string | null` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. - `created_at: string` RFC 3339 datetime string representing the time at which the Message Batch was created. - `ended_at: string | null` RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends. Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired. - `expires_at: string` RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. - `processing_status: "in_progress" | "canceling" | "ended"` Processing status of the Message Batch. - `"in_progress"` - `"canceling"` - `"ended"` - `request_counts: BetaMessageBatchRequestCounts` Tallies requests within the Message Batch, categorized by their status. Requests start as `processing` and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch. - `canceled: number` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. - `errored: number` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. - `expired: number` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. - `processing: number` Number of requests in the Message Batch that are processing. - `succeeded: number` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. - `results_url: string | null` URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. - `type: "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. - `"message_batch"` ### Example ```typescript import Anthropic from '@anthropic-ai/sdk'; const client = new Anthropic({ apiKey: process.env['ANTHROPIC_API_KEY'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const betaMessageBatch of client.beta.messages.batches.list()) { console.log(betaMessageBatch.id); } ``` #### Response ```json { "data": [ { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } ], "first_id": "first_id", "has_more": true, "last_id": "last_id" } ``` ## Cancel a Message Batch `client.beta.messages.batches.cancel(stringmessageBatchID, BatchCancelParamsparams?, RequestOptionsoptions?): BetaMessageBatch` **post** `/v1/messages/batches/{message_batch_id}/cancel` Batches may be canceled any time before processing ends. Once cancellation is initiated, the batch enters a `canceling` state, at which time the system may complete any in-progress, non-interruptible requests before finalizing cancellation. The number of canceled requests is specified in `request_counts`. To determine which requests were canceled, check the individual results within the batch. Note that cancellation may not result in any canceled requests if they were non-interruptible. Learn more about the Message Batches API in our [user guide](https://docs.claude.com/en/docs/build-with-claude/batch-processing) ### Parameters - `messageBatchID: string` ID of the Message Batch. - `params: BatchCancelParams` - `betas?: Array` Optional header to specify the beta version(s) you want to use. - `(string & {})` - `"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 - `BetaMessageBatch` - `id: string` Unique object identifier. The format and length of IDs may change over time. - `archived_at: string | null` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. - `cancel_initiated_at: string | null` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. - `created_at: string` RFC 3339 datetime string representing the time at which the Message Batch was created. - `ended_at: string | null` RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends. Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired. - `expires_at: string` RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. - `processing_status: "in_progress" | "canceling" | "ended"` Processing status of the Message Batch. - `"in_progress"` - `"canceling"` - `"ended"` - `request_counts: BetaMessageBatchRequestCounts` Tallies requests within the Message Batch, categorized by their status. Requests start as `processing` and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch. - `canceled: number` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. - `errored: number` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. - `expired: number` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. - `processing: number` Number of requests in the Message Batch that are processing. - `succeeded: number` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. - `results_url: string | null` URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. - `type: "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. - `"message_batch"` ### Example ```typescript import Anthropic from '@anthropic-ai/sdk'; const client = new Anthropic({ apiKey: process.env['ANTHROPIC_API_KEY'], // This is the default and can be omitted }); const betaMessageBatch = await client.beta.messages.batches.cancel('message_batch_id'); console.log(betaMessageBatch.id); ``` #### Response ```json { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } ``` ## Delete a Message Batch `client.beta.messages.batches.delete(stringmessageBatchID, BatchDeleteParamsparams?, RequestOptionsoptions?): BetaDeletedMessageBatch` **delete** `/v1/messages/batches/{message_batch_id}` Delete a Message Batch. Message Batches can only be deleted once they've finished processing. If you'd like to delete an in-progress batch, you must first cancel it. Learn more about the Message Batches API in our [user guide](https://docs.claude.com/en/docs/build-with-claude/batch-processing) ### Parameters - `messageBatchID: string` ID of the Message Batch. - `params: BatchDeleteParams` - `betas?: Array` Optional header to specify the beta version(s) you want to use. - `(string & {})` - `"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 - `BetaDeletedMessageBatch` - `id: string` ID of the Message Batch. - `type: "message_batch_deleted"` Deleted object type. For Message Batches, this is always `"message_batch_deleted"`. - `"message_batch_deleted"` ### Example ```typescript import Anthropic from '@anthropic-ai/sdk'; const client = new Anthropic({ apiKey: process.env['ANTHROPIC_API_KEY'], // This is the default and can be omitted }); const betaDeletedMessageBatch = await client.beta.messages.batches.delete('message_batch_id'); console.log(betaDeletedMessageBatch.id); ``` #### Response ```json { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "type": "message_batch_deleted" } ``` ## Retrieve Message Batch results `client.beta.messages.batches.results(stringmessageBatchID, BatchResultsParamsparams?, RequestOptionsoptions?): BetaMessageBatchIndividualResponse | Stream` **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 - `messageBatchID: string` ID of the Message Batch. - `params: BatchResultsParams` - `betas?: Array` Optional header to specify the beta version(s) you want to use. - `(string & {})` - `"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 - `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. - `BetaMessageBatchSucceededResult` - `message: BetaMessage` - `id: string` Unique object identifier. The format and length of IDs may change over time. - `container: BetaContainer | null` 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 | null` 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` 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)"}] ``` - `BetaTextBlock` - `citations: Array | null` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `BetaCitationCharLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `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: number` - `document_title: string | null` - `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 | null` - `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` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `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: 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 | null` - `type: "search_result_location"` - `"search_result_location"` - `text: string` - `type: "text"` - `"text"` - `BetaThinkingBlock` - `signature: string` - `thinking: string` - `type: "thinking"` - `"thinking"` - `BetaRedactedThinkingBlock` - `data: string` - `type: "redacted_thinking"` - `"redacted_thinking"` - `BetaToolUseBlock` - `id: string` - `input: Record` - `name: string` - `type: "tool_use"` - `"tool_use"` - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `type: "direct"` - `"direct"` - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `BetaServerToolCaller20260120` - `tool_id: string` - `type: "code_execution_20260120"` - `"code_execution_20260120"` - `BetaServerToolUseBlock` - `id: string` - `input: Record` - `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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebSearchToolResultBlock` - `content: BetaWebSearchToolResultBlockContent` - `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"` - `Array` - `encrypted_content: string` - `page_age: string | null` - `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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebFetchToolResultBlock` - `content: BetaWebFetchToolResultErrorBlock | BetaWebFetchBlock` - `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"` - `BetaWebFetchBlock` - `content: BetaDocumentBlock` - `citations: BetaCitationConfig | null` Citation configuration for the document - `enabled: boolean` - `source: BetaBase64PDFSource | BetaPlainTextSource` - `BetaBase64PDFSource` - `data: string` - `media_type: "application/pdf"` - `"application/pdf"` - `type: "base64"` - `"base64"` - `BetaPlainTextSource` - `data: string` - `media_type: "text/plain"` - `"text/plain"` - `type: "text"` - `"text"` - `title: string | null` The title of the document - `type: "document"` - `"document"` - `retrieved_at: string | null` 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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaAdvisorToolResultBlock` - `content: BetaAdvisorToolResultError | BetaAdvisorResultBlock | BetaAdvisorRedactedResultBlock` - `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"` - `BetaAdvisorResultBlock` - `stop_reason: string | null` 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"` - `BetaAdvisorRedactedResultBlock` - `encrypted_content: string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `stop_reason: string | null` 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"` - `BetaCodeExecutionToolResultBlock` - `content: BetaCodeExecutionToolResultBlockContent` Code execution result with encrypted stdout for PFC + web_search results. - `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"` - `BetaCodeExecutionResultBlock` - `content: Array` - `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` Code execution result with encrypted stdout for PFC + web_search results. - `content: Array` - `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` - `content: BetaBashCodeExecutionToolResultError | BetaBashCodeExecutionResultBlock` - `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"` - `BetaBashCodeExecutionResultBlock` - `content: Array` - `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` - `content: BetaTextEditorCodeExecutionToolResultError | BetaTextEditorCodeExecutionViewResultBlock | BetaTextEditorCodeExecutionCreateResultBlock | BetaTextEditorCodeExecutionStrReplaceResultBlock` - `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 | null` - `type: "text_editor_code_execution_tool_result_error"` - `"text_editor_code_execution_tool_result_error"` - `BetaTextEditorCodeExecutionViewResultBlock` - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number | null` - `start_line: number | null` - `total_lines: number | null` - `type: "text_editor_code_execution_view_result"` - `"text_editor_code_execution_view_result"` - `BetaTextEditorCodeExecutionCreateResultBlock` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `"text_editor_code_execution_create_result"` - `BetaTextEditorCodeExecutionStrReplaceResultBlock` - `lines: Array | null` - `new_lines: number | null` - `new_start: number | null` - `old_lines: number | null` - `old_start: number | null` - `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` - `content: BetaToolSearchToolResultError | BetaToolSearchToolSearchResultBlock` - `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 | null` - `type: "tool_search_tool_result_error"` - `"tool_search_tool_result_error"` - `BetaToolSearchToolSearchResultBlock` - `tool_references: Array` - `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` - `id: string` - `input: Record` - `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` - `content: string | Array` - `string` - `Array` - `citations: Array | null` 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` Response model for a file uploaded to the container. - `file_id: string` - `type: "container_upload"` - `"container_upload"` - `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 | null` Summary of compacted content, or null if compaction failed - `encrypted_content: string | null` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction"` - `"compaction"` - `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. - `"claude-fable-5" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` - `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 | null` Context management response. Information about context management strategies applied during the request. - `applied_edits: Array` List of context management edits that were applied. - `BetaClearToolUses20250919EditResponse` - `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` - `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 | null` 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 | null` 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` - `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` - `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` - `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` - `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` - `type: "previous_message_not_found"` - `"previous_message_not_found"` - `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 | null` Structured information about a refusal. - `category: "cyber" | "bio" | "reasoning_extraction" | null` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` - `"bio"` - `"reasoning_extraction"` - `explanation: string | null` 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 | null` 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: boolean | null` 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 | null` 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 | null` 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 | null` 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 | null` 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 | null` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number | null` The number of input tokens read from the cache. - `inference_geo: string | null` The geographic region where inference was performed for this request. - `input_tokens: number` The number of input tokens which were used. - `iterations: BetaIterationsUsage | null` 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` Token usage for a sampling iteration. - `cache_creation: BetaCacheCreation | null` 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](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: number` The number of output tokens which were used. - `type: "message"` Usage for a sampling iteration - `"message"` - `BetaCompactionIterationUsage` Token usage for a compaction iteration. - `cache_creation: BetaCacheCreation | null` 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` Token usage for an advisor sub-inference iteration. - `cache_creation: BetaCacheCreation | null` 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](https://docs.anthropic.com/en/docs/models-overview) 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"` - `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 | null` 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](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: number` 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: number` The number of output tokens which were used. - `output_tokens_details: BetaOutputTokensDetails | null` 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: number` 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 | null` 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" | "priority" | "batch" | null` If the request used the priority, standard, or batch tier. - `"standard"` - `"priority"` - `"batch"` - `speed: "standard" | "fast" | null` The inference speed mode used for this request. - `"standard"` - `"fast"` - `type: "succeeded"` - `"succeeded"` - `BetaMessageBatchErroredResult` - `error: BetaErrorResponse` - `error: BetaError` - `BetaInvalidRequestError` - `message: string` - `type: "invalid_request_error"` - `"invalid_request_error"` - `BetaAuthenticationError` - `message: string` - `type: "authentication_error"` - `"authentication_error"` - `BetaBillingError` - `message: string` - `type: "billing_error"` - `"billing_error"` - `BetaPermissionError` - `message: string` - `type: "permission_error"` - `"permission_error"` - `BetaNotFoundError` - `message: string` - `type: "not_found_error"` - `"not_found_error"` - `BetaRateLimitError` - `message: string` - `type: "rate_limit_error"` - `"rate_limit_error"` - `BetaGatewayTimeoutError` - `message: string` - `type: "timeout_error"` - `"timeout_error"` - `BetaAPIError` - `message: string` - `type: "api_error"` - `"api_error"` - `BetaOverloadedError` - `message: string` - `type: "overloaded_error"` - `"overloaded_error"` - `request_id: string | null` - `type: "error"` - `"error"` - `type: "errored"` - `"errored"` - `BetaMessageBatchCanceledResult` - `type: "canceled"` - `"canceled"` - `BetaMessageBatchExpiredResult` - `type: "expired"` - `"expired"` ### Example ```typescript import Anthropic from '@anthropic-ai/sdk'; const client = new Anthropic({ apiKey: process.env['ANTHROPIC_API_KEY'], // This is the default and can be omitted }); const betaMessageBatchIndividualResponse = await client.beta.messages.batches.results( 'message_batch_id', ); console.log(betaMessageBatchIndividualResponse.custom_id); ``` ## Domain Types ### Beta Deleted Message Batch - `BetaDeletedMessageBatch` - `id: string` ID of the Message Batch. - `type: "message_batch_deleted"` Deleted object type. For Message Batches, this is always `"message_batch_deleted"`. - `"message_batch_deleted"` ### Beta Message Batch - `BetaMessageBatch` - `id: string` Unique object identifier. The format and length of IDs may change over time. - `archived_at: string | null` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. - `cancel_initiated_at: string | null` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. - `created_at: string` RFC 3339 datetime string representing the time at which the Message Batch was created. - `ended_at: string | null` RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends. Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired. - `expires_at: string` RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. - `processing_status: "in_progress" | "canceling" | "ended"` Processing status of the Message Batch. - `"in_progress"` - `"canceling"` - `"ended"` - `request_counts: BetaMessageBatchRequestCounts` Tallies requests within the Message Batch, categorized by their status. Requests start as `processing` and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch. - `canceled: number` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. - `errored: number` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. - `expired: number` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. - `processing: number` Number of requests in the Message Batch that are processing. - `succeeded: number` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. - `results_url: string | null` URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. - `type: "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. - `"message_batch"` ### Beta Message Batch Canceled Result - `BetaMessageBatchCanceledResult` - `type: "canceled"` - `"canceled"` ### Beta Message Batch Errored Result - `BetaMessageBatchErroredResult` - `error: BetaErrorResponse` - `error: BetaError` - `BetaInvalidRequestError` - `message: string` - `type: "invalid_request_error"` - `"invalid_request_error"` - `BetaAuthenticationError` - `message: string` - `type: "authentication_error"` - `"authentication_error"` - `BetaBillingError` - `message: string` - `type: "billing_error"` - `"billing_error"` - `BetaPermissionError` - `message: string` - `type: "permission_error"` - `"permission_error"` - `BetaNotFoundError` - `message: string` - `type: "not_found_error"` - `"not_found_error"` - `BetaRateLimitError` - `message: string` - `type: "rate_limit_error"` - `"rate_limit_error"` - `BetaGatewayTimeoutError` - `message: string` - `type: "timeout_error"` - `"timeout_error"` - `BetaAPIError` - `message: string` - `type: "api_error"` - `"api_error"` - `BetaOverloadedError` - `message: string` - `type: "overloaded_error"` - `"overloaded_error"` - `request_id: string | null` - `type: "error"` - `"error"` - `type: "errored"` - `"errored"` ### Beta Message Batch Expired Result - `BetaMessageBatchExpiredResult` - `type: "expired"` - `"expired"` ### Beta Message Batch Individual Response - `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. - `BetaMessageBatchSucceededResult` - `message: BetaMessage` - `id: string` Unique object identifier. The format and length of IDs may change over time. - `container: BetaContainer | null` 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 | null` 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` 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)"}] ``` - `BetaTextBlock` - `citations: Array | null` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `BetaCitationCharLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `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: number` - `document_title: string | null` - `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 | null` - `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` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `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: 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 | null` - `type: "search_result_location"` - `"search_result_location"` - `text: string` - `type: "text"` - `"text"` - `BetaThinkingBlock` - `signature: string` - `thinking: string` - `type: "thinking"` - `"thinking"` - `BetaRedactedThinkingBlock` - `data: string` - `type: "redacted_thinking"` - `"redacted_thinking"` - `BetaToolUseBlock` - `id: string` - `input: Record` - `name: string` - `type: "tool_use"` - `"tool_use"` - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `type: "direct"` - `"direct"` - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `BetaServerToolCaller20260120` - `tool_id: string` - `type: "code_execution_20260120"` - `"code_execution_20260120"` - `BetaServerToolUseBlock` - `id: string` - `input: Record` - `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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebSearchToolResultBlock` - `content: BetaWebSearchToolResultBlockContent` - `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"` - `Array` - `encrypted_content: string` - `page_age: string | null` - `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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebFetchToolResultBlock` - `content: BetaWebFetchToolResultErrorBlock | BetaWebFetchBlock` - `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"` - `BetaWebFetchBlock` - `content: BetaDocumentBlock` - `citations: BetaCitationConfig | null` Citation configuration for the document - `enabled: boolean` - `source: BetaBase64PDFSource | BetaPlainTextSource` - `BetaBase64PDFSource` - `data: string` - `media_type: "application/pdf"` - `"application/pdf"` - `type: "base64"` - `"base64"` - `BetaPlainTextSource` - `data: string` - `media_type: "text/plain"` - `"text/plain"` - `type: "text"` - `"text"` - `title: string | null` The title of the document - `type: "document"` - `"document"` - `retrieved_at: string | null` 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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaAdvisorToolResultBlock` - `content: BetaAdvisorToolResultError | BetaAdvisorResultBlock | BetaAdvisorRedactedResultBlock` - `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"` - `BetaAdvisorResultBlock` - `stop_reason: string | null` 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"` - `BetaAdvisorRedactedResultBlock` - `encrypted_content: string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `stop_reason: string | null` 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"` - `BetaCodeExecutionToolResultBlock` - `content: BetaCodeExecutionToolResultBlockContent` Code execution result with encrypted stdout for PFC + web_search results. - `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"` - `BetaCodeExecutionResultBlock` - `content: Array` - `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` Code execution result with encrypted stdout for PFC + web_search results. - `content: Array` - `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` - `content: BetaBashCodeExecutionToolResultError | BetaBashCodeExecutionResultBlock` - `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"` - `BetaBashCodeExecutionResultBlock` - `content: Array` - `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` - `content: BetaTextEditorCodeExecutionToolResultError | BetaTextEditorCodeExecutionViewResultBlock | BetaTextEditorCodeExecutionCreateResultBlock | BetaTextEditorCodeExecutionStrReplaceResultBlock` - `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 | null` - `type: "text_editor_code_execution_tool_result_error"` - `"text_editor_code_execution_tool_result_error"` - `BetaTextEditorCodeExecutionViewResultBlock` - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number | null` - `start_line: number | null` - `total_lines: number | null` - `type: "text_editor_code_execution_view_result"` - `"text_editor_code_execution_view_result"` - `BetaTextEditorCodeExecutionCreateResultBlock` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `"text_editor_code_execution_create_result"` - `BetaTextEditorCodeExecutionStrReplaceResultBlock` - `lines: Array | null` - `new_lines: number | null` - `new_start: number | null` - `old_lines: number | null` - `old_start: number | null` - `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` - `content: BetaToolSearchToolResultError | BetaToolSearchToolSearchResultBlock` - `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 | null` - `type: "tool_search_tool_result_error"` - `"tool_search_tool_result_error"` - `BetaToolSearchToolSearchResultBlock` - `tool_references: Array` - `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` - `id: string` - `input: Record` - `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` - `content: string | Array` - `string` - `Array` - `citations: Array | null` 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` Response model for a file uploaded to the container. - `file_id: string` - `type: "container_upload"` - `"container_upload"` - `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 | null` Summary of compacted content, or null if compaction failed - `encrypted_content: string | null` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction"` - `"compaction"` - `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. - `"claude-fable-5" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` - `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 | null` Context management response. Information about context management strategies applied during the request. - `applied_edits: Array` List of context management edits that were applied. - `BetaClearToolUses20250919EditResponse` - `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` - `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 | null` 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 | null` 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` - `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` - `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` - `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` - `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` - `type: "previous_message_not_found"` - `"previous_message_not_found"` - `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 | null` Structured information about a refusal. - `category: "cyber" | "bio" | "reasoning_extraction" | null` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` - `"bio"` - `"reasoning_extraction"` - `explanation: string | null` 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 | null` 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: boolean | null` 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 | null` 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 | null` 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 | null` 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 | null` 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 | null` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number | null` The number of input tokens read from the cache. - `inference_geo: string | null` The geographic region where inference was performed for this request. - `input_tokens: number` The number of input tokens which were used. - `iterations: BetaIterationsUsage | null` 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` Token usage for a sampling iteration. - `cache_creation: BetaCacheCreation | null` 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](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: number` The number of output tokens which were used. - `type: "message"` Usage for a sampling iteration - `"message"` - `BetaCompactionIterationUsage` Token usage for a compaction iteration. - `cache_creation: BetaCacheCreation | null` 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` Token usage for an advisor sub-inference iteration. - `cache_creation: BetaCacheCreation | null` 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](https://docs.anthropic.com/en/docs/models-overview) 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"` - `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 | null` 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](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: number` 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: number` The number of output tokens which were used. - `output_tokens_details: BetaOutputTokensDetails | null` 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: number` 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 | null` 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" | "priority" | "batch" | null` If the request used the priority, standard, or batch tier. - `"standard"` - `"priority"` - `"batch"` - `speed: "standard" | "fast" | null` The inference speed mode used for this request. - `"standard"` - `"fast"` - `type: "succeeded"` - `"succeeded"` - `BetaMessageBatchErroredResult` - `error: BetaErrorResponse` - `error: BetaError` - `BetaInvalidRequestError` - `message: string` - `type: "invalid_request_error"` - `"invalid_request_error"` - `BetaAuthenticationError` - `message: string` - `type: "authentication_error"` - `"authentication_error"` - `BetaBillingError` - `message: string` - `type: "billing_error"` - `"billing_error"` - `BetaPermissionError` - `message: string` - `type: "permission_error"` - `"permission_error"` - `BetaNotFoundError` - `message: string` - `type: "not_found_error"` - `"not_found_error"` - `BetaRateLimitError` - `message: string` - `type: "rate_limit_error"` - `"rate_limit_error"` - `BetaGatewayTimeoutError` - `message: string` - `type: "timeout_error"` - `"timeout_error"` - `BetaAPIError` - `message: string` - `type: "api_error"` - `"api_error"` - `BetaOverloadedError` - `message: string` - `type: "overloaded_error"` - `"overloaded_error"` - `request_id: string | null` - `type: "error"` - `"error"` - `type: "errored"` - `"errored"` - `BetaMessageBatchCanceledResult` - `type: "canceled"` - `"canceled"` - `BetaMessageBatchExpiredResult` - `type: "expired"` - `"expired"` ### Beta Message Batch Request Counts - `BetaMessageBatchRequestCounts` - `canceled: number` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. - `errored: number` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. - `expired: number` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. - `processing: number` Number of requests in the Message Batch that are processing. - `succeeded: number` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. ### Beta Message Batch Result - `BetaMessageBatchResult = BetaMessageBatchSucceededResult | BetaMessageBatchErroredResult | BetaMessageBatchCanceledResult | BetaMessageBatchExpiredResult` Processing result for this request. Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration. - `BetaMessageBatchSucceededResult` - `message: BetaMessage` - `id: string` Unique object identifier. The format and length of IDs may change over time. - `container: BetaContainer | null` 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 | null` 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` 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)"}] ``` - `BetaTextBlock` - `citations: Array | null` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `BetaCitationCharLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `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: number` - `document_title: string | null` - `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 | null` - `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` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `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: 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 | null` - `type: "search_result_location"` - `"search_result_location"` - `text: string` - `type: "text"` - `"text"` - `BetaThinkingBlock` - `signature: string` - `thinking: string` - `type: "thinking"` - `"thinking"` - `BetaRedactedThinkingBlock` - `data: string` - `type: "redacted_thinking"` - `"redacted_thinking"` - `BetaToolUseBlock` - `id: string` - `input: Record` - `name: string` - `type: "tool_use"` - `"tool_use"` - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `type: "direct"` - `"direct"` - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `BetaServerToolCaller20260120` - `tool_id: string` - `type: "code_execution_20260120"` - `"code_execution_20260120"` - `BetaServerToolUseBlock` - `id: string` - `input: Record` - `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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebSearchToolResultBlock` - `content: BetaWebSearchToolResultBlockContent` - `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"` - `Array` - `encrypted_content: string` - `page_age: string | null` - `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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebFetchToolResultBlock` - `content: BetaWebFetchToolResultErrorBlock | BetaWebFetchBlock` - `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"` - `BetaWebFetchBlock` - `content: BetaDocumentBlock` - `citations: BetaCitationConfig | null` Citation configuration for the document - `enabled: boolean` - `source: BetaBase64PDFSource | BetaPlainTextSource` - `BetaBase64PDFSource` - `data: string` - `media_type: "application/pdf"` - `"application/pdf"` - `type: "base64"` - `"base64"` - `BetaPlainTextSource` - `data: string` - `media_type: "text/plain"` - `"text/plain"` - `type: "text"` - `"text"` - `title: string | null` The title of the document - `type: "document"` - `"document"` - `retrieved_at: string | null` 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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaAdvisorToolResultBlock` - `content: BetaAdvisorToolResultError | BetaAdvisorResultBlock | BetaAdvisorRedactedResultBlock` - `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"` - `BetaAdvisorResultBlock` - `stop_reason: string | null` 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"` - `BetaAdvisorRedactedResultBlock` - `encrypted_content: string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `stop_reason: string | null` 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"` - `BetaCodeExecutionToolResultBlock` - `content: BetaCodeExecutionToolResultBlockContent` Code execution result with encrypted stdout for PFC + web_search results. - `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"` - `BetaCodeExecutionResultBlock` - `content: Array` - `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` Code execution result with encrypted stdout for PFC + web_search results. - `content: Array` - `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` - `content: BetaBashCodeExecutionToolResultError | BetaBashCodeExecutionResultBlock` - `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"` - `BetaBashCodeExecutionResultBlock` - `content: Array` - `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` - `content: BetaTextEditorCodeExecutionToolResultError | BetaTextEditorCodeExecutionViewResultBlock | BetaTextEditorCodeExecutionCreateResultBlock | BetaTextEditorCodeExecutionStrReplaceResultBlock` - `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 | null` - `type: "text_editor_code_execution_tool_result_error"` - `"text_editor_code_execution_tool_result_error"` - `BetaTextEditorCodeExecutionViewResultBlock` - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number | null` - `start_line: number | null` - `total_lines: number | null` - `type: "text_editor_code_execution_view_result"` - `"text_editor_code_execution_view_result"` - `BetaTextEditorCodeExecutionCreateResultBlock` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `"text_editor_code_execution_create_result"` - `BetaTextEditorCodeExecutionStrReplaceResultBlock` - `lines: Array | null` - `new_lines: number | null` - `new_start: number | null` - `old_lines: number | null` - `old_start: number | null` - `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` - `content: BetaToolSearchToolResultError | BetaToolSearchToolSearchResultBlock` - `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 | null` - `type: "tool_search_tool_result_error"` - `"tool_search_tool_result_error"` - `BetaToolSearchToolSearchResultBlock` - `tool_references: Array` - `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` - `id: string` - `input: Record` - `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` - `content: string | Array` - `string` - `Array` - `citations: Array | null` 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` Response model for a file uploaded to the container. - `file_id: string` - `type: "container_upload"` - `"container_upload"` - `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 | null` Summary of compacted content, or null if compaction failed - `encrypted_content: string | null` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction"` - `"compaction"` - `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. - `"claude-fable-5" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` - `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 | null` Context management response. Information about context management strategies applied during the request. - `applied_edits: Array` List of context management edits that were applied. - `BetaClearToolUses20250919EditResponse` - `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` - `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 | null` 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 | null` 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` - `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` - `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` - `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` - `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` - `type: "previous_message_not_found"` - `"previous_message_not_found"` - `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 | null` Structured information about a refusal. - `category: "cyber" | "bio" | "reasoning_extraction" | null` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` - `"bio"` - `"reasoning_extraction"` - `explanation: string | null` 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 | null` 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: boolean | null` 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 | null` 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 | null` 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 | null` 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 | null` 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 | null` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number | null` The number of input tokens read from the cache. - `inference_geo: string | null` The geographic region where inference was performed for this request. - `input_tokens: number` The number of input tokens which were used. - `iterations: BetaIterationsUsage | null` 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` Token usage for a sampling iteration. - `cache_creation: BetaCacheCreation | null` 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](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: number` The number of output tokens which were used. - `type: "message"` Usage for a sampling iteration - `"message"` - `BetaCompactionIterationUsage` Token usage for a compaction iteration. - `cache_creation: BetaCacheCreation | null` 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` Token usage for an advisor sub-inference iteration. - `cache_creation: BetaCacheCreation | null` 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](https://docs.anthropic.com/en/docs/models-overview) 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"` - `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 | null` 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](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: number` 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: number` The number of output tokens which were used. - `output_tokens_details: BetaOutputTokensDetails | null` 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: number` 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 | null` 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" | "priority" | "batch" | null` If the request used the priority, standard, or batch tier. - `"standard"` - `"priority"` - `"batch"` - `speed: "standard" | "fast" | null` The inference speed mode used for this request. - `"standard"` - `"fast"` - `type: "succeeded"` - `"succeeded"` - `BetaMessageBatchErroredResult` - `error: BetaErrorResponse` - `error: BetaError` - `BetaInvalidRequestError` - `message: string` - `type: "invalid_request_error"` - `"invalid_request_error"` - `BetaAuthenticationError` - `message: string` - `type: "authentication_error"` - `"authentication_error"` - `BetaBillingError` - `message: string` - `type: "billing_error"` - `"billing_error"` - `BetaPermissionError` - `message: string` - `type: "permission_error"` - `"permission_error"` - `BetaNotFoundError` - `message: string` - `type: "not_found_error"` - `"not_found_error"` - `BetaRateLimitError` - `message: string` - `type: "rate_limit_error"` - `"rate_limit_error"` - `BetaGatewayTimeoutError` - `message: string` - `type: "timeout_error"` - `"timeout_error"` - `BetaAPIError` - `message: string` - `type: "api_error"` - `"api_error"` - `BetaOverloadedError` - `message: string` - `type: "overloaded_error"` - `"overloaded_error"` - `request_id: string | null` - `type: "error"` - `"error"` - `type: "errored"` - `"errored"` - `BetaMessageBatchCanceledResult` - `type: "canceled"` - `"canceled"` - `BetaMessageBatchExpiredResult` - `type: "expired"` - `"expired"` ### Beta Message Batch Succeeded Result - `BetaMessageBatchSucceededResult` - `message: BetaMessage` - `id: string` Unique object identifier. The format and length of IDs may change over time. - `container: BetaContainer | null` 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 | null` 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` 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)"}] ``` - `BetaTextBlock` - `citations: Array | null` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `BetaCitationCharLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` - `type: "char_location"` - `"char_location"` - `BetaCitationPageLocation` - `cited_text: string` - `document_index: number` - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` - `type: "page_location"` - `"page_location"` - `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: number` - `document_title: string | null` - `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 | null` - `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` - `cited_text: string` - `encrypted_index: string` - `title: string | null` - `type: "web_search_result_location"` - `"web_search_result_location"` - `url: string` - `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: 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 | null` - `type: "search_result_location"` - `"search_result_location"` - `text: string` - `type: "text"` - `"text"` - `BetaThinkingBlock` - `signature: string` - `thinking: string` - `type: "thinking"` - `"thinking"` - `BetaRedactedThinkingBlock` - `data: string` - `type: "redacted_thinking"` - `"redacted_thinking"` - `BetaToolUseBlock` - `id: string` - `input: Record` - `name: string` - `type: "tool_use"` - `"tool_use"` - `caller?: BetaDirectCaller | BetaServerToolCaller | BetaServerToolCaller20260120` Tool invocation directly from the model. - `BetaDirectCaller` Tool invocation directly from the model. - `type: "direct"` - `"direct"` - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `"code_execution_20250825"` - `BetaServerToolCaller20260120` - `tool_id: string` - `type: "code_execution_20260120"` - `"code_execution_20260120"` - `BetaServerToolUseBlock` - `id: string` - `input: Record` - `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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebSearchToolResultBlock` - `content: BetaWebSearchToolResultBlockContent` - `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"` - `Array` - `encrypted_content: string` - `page_age: string | null` - `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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaWebFetchToolResultBlock` - `content: BetaWebFetchToolResultErrorBlock | BetaWebFetchBlock` - `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"` - `BetaWebFetchBlock` - `content: BetaDocumentBlock` - `citations: BetaCitationConfig | null` Citation configuration for the document - `enabled: boolean` - `source: BetaBase64PDFSource | BetaPlainTextSource` - `BetaBase64PDFSource` - `data: string` - `media_type: "application/pdf"` - `"application/pdf"` - `type: "base64"` - `"base64"` - `BetaPlainTextSource` - `data: string` - `media_type: "text/plain"` - `"text/plain"` - `type: "text"` - `"text"` - `title: string | null` The title of the document - `type: "document"` - `"document"` - `retrieved_at: string | null` 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. - `BetaDirectCaller` Tool invocation directly from the model. - `BetaServerToolCaller` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120` - `BetaAdvisorToolResultBlock` - `content: BetaAdvisorToolResultError | BetaAdvisorResultBlock | BetaAdvisorRedactedResultBlock` - `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"` - `BetaAdvisorResultBlock` - `stop_reason: string | null` 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"` - `BetaAdvisorRedactedResultBlock` - `encrypted_content: string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `stop_reason: string | null` 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"` - `BetaCodeExecutionToolResultBlock` - `content: BetaCodeExecutionToolResultBlockContent` Code execution result with encrypted stdout for PFC + web_search results. - `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"` - `BetaCodeExecutionResultBlock` - `content: Array` - `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` Code execution result with encrypted stdout for PFC + web_search results. - `content: Array` - `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` - `content: BetaBashCodeExecutionToolResultError | BetaBashCodeExecutionResultBlock` - `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"` - `BetaBashCodeExecutionResultBlock` - `content: Array` - `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` - `content: BetaTextEditorCodeExecutionToolResultError | BetaTextEditorCodeExecutionViewResultBlock | BetaTextEditorCodeExecutionCreateResultBlock | BetaTextEditorCodeExecutionStrReplaceResultBlock` - `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 | null` - `type: "text_editor_code_execution_tool_result_error"` - `"text_editor_code_execution_tool_result_error"` - `BetaTextEditorCodeExecutionViewResultBlock` - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number | null` - `start_line: number | null` - `total_lines: number | null` - `type: "text_editor_code_execution_view_result"` - `"text_editor_code_execution_view_result"` - `BetaTextEditorCodeExecutionCreateResultBlock` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `"text_editor_code_execution_create_result"` - `BetaTextEditorCodeExecutionStrReplaceResultBlock` - `lines: Array | null` - `new_lines: number | null` - `new_start: number | null` - `old_lines: number | null` - `old_start: number | null` - `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` - `content: BetaToolSearchToolResultError | BetaToolSearchToolSearchResultBlock` - `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 | null` - `type: "tool_search_tool_result_error"` - `"tool_search_tool_result_error"` - `BetaToolSearchToolSearchResultBlock` - `tool_references: Array` - `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` - `id: string` - `input: Record` - `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` - `content: string | Array` - `string` - `Array` - `citations: Array | null` 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` Response model for a file uploaded to the container. - `file_id: string` - `type: "container_upload"` - `"container_upload"` - `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 | null` Summary of compacted content, or null if compaction failed - `encrypted_content: string | null` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction"` - `"compaction"` - `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. - `"claude-fable-5" | "claude-mythos-5" | "claude-opus-4-8" | 17 more` - `"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 & {})` - `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 | null` Context management response. Information about context management strategies applied during the request. - `applied_edits: Array` List of context management edits that were applied. - `BetaClearToolUses20250919EditResponse` - `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` - `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 | null` 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 | null` 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` - `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` - `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` - `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` - `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` - `type: "previous_message_not_found"` - `"previous_message_not_found"` - `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 | null` Structured information about a refusal. - `category: "cyber" | "bio" | "reasoning_extraction" | null` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` - `"bio"` - `"reasoning_extraction"` - `explanation: string | null` 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 | null` 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: boolean | null` 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 | null` 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 | null` 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 | null` 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 | null` 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 | null` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number | null` The number of input tokens read from the cache. - `inference_geo: string | null` The geographic region where inference was performed for this request. - `input_tokens: number` The number of input tokens which were used. - `iterations: BetaIterationsUsage | null` 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` Token usage for a sampling iteration. - `cache_creation: BetaCacheCreation | null` 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](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: number` The number of output tokens which were used. - `type: "message"` Usage for a sampling iteration - `"message"` - `BetaCompactionIterationUsage` Token usage for a compaction iteration. - `cache_creation: BetaCacheCreation | null` 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` Token usage for an advisor sub-inference iteration. - `cache_creation: BetaCacheCreation | null` 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](https://docs.anthropic.com/en/docs/models-overview) 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"` - `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 | null` 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](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: number` 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: number` The number of output tokens which were used. - `output_tokens_details: BetaOutputTokensDetails | null` 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: number` 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 | null` 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" | "priority" | "batch" | null` If the request used the priority, standard, or batch tier. - `"standard"` - `"priority"` - `"batch"` - `speed: "standard" | "fast" | null` The inference speed mode used for this request. - `"standard"` - `"fast"` - `type: "succeeded"` - `"succeeded"`