Beta
ModelsExpand Collapse
AnthropicBeta = String | :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 16 more
:"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 16 more
class BetaAPIError { message, type }
type: :api_error
class BetaAuthenticationError { message, type }
type: :authentication_error
class BetaBillingError { message, type }
type: :billing_error
BetaError = BetaInvalidRequestError { message, type } | BetaAuthenticationError { message, type } | BetaBillingError { message, type } | 6 more
class BetaInvalidRequestError { message, type }
type: :invalid_request_error
class BetaAuthenticationError { message, type }
type: :authentication_error
class BetaBillingError { message, type }
type: :billing_error
class BetaPermissionError { message, type }
type: :permission_error
class BetaNotFoundError { message, type }
type: :not_found_error
class BetaRateLimitError { message, type }
type: :rate_limit_error
class BetaGatewayTimeoutError { message, type }
type: :timeout_error
class BetaAPIError { message, type }
type: :api_error
class BetaOverloadedError { message, type }
type: :overloaded_error
class BetaErrorResponse { error, request_id, type }
class BetaInvalidRequestError { message, type }
type: :invalid_request_error
class BetaAuthenticationError { message, type }
type: :authentication_error
class BetaBillingError { message, type }
type: :billing_error
class BetaPermissionError { message, type }
type: :permission_error
class BetaNotFoundError { message, type }
type: :not_found_error
class BetaRateLimitError { message, type }
type: :rate_limit_error
class BetaGatewayTimeoutError { message, type }
type: :timeout_error
class BetaAPIError { message, type }
type: :api_error
class BetaOverloadedError { message, type }
type: :overloaded_error
type: :error
class BetaGatewayTimeoutError { message, type }
type: :timeout_error
class BetaInvalidRequestError { message, type }
type: :invalid_request_error
class BetaNotFoundError { message, type }
type: :not_found_error
class BetaOverloadedError { message, type }
type: :overloaded_error
class BetaPermissionError { message, type }
type: :permission_error
class BetaRateLimitError { message, type }
type: :rate_limit_error
BetaModels
List Models
Get a Model
ModelsExpand Collapse
class BetaModelInfo { id, created_at, display_name, type }
id: String
Unique model identifier.
created_at: Time
RFC 3339 datetime string representing the time at which the model was released. May be set to an epoch value if the release date is unknown.
display_name: String
A human-readable name for the model.
type: :model
Object type.
For Models, this is always "model".
BetaMessages
Create a Message
Count tokens in a Message
ModelsExpand Collapse
class BetaAllThinkingTurns { type }
type: :all
class BetaBase64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
type: :base64
class BetaBase64PDFSource { data, media_type, type }
media_type: :"application/pdf"
type: :base64
class BetaBashCodeExecutionOutputBlock { file_id, type }
type: :bash_code_execution_output
class BetaBashCodeExecutionOutputBlockParam { file_id, type }
type: :bash_code_execution_output
class BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
type: :bash_code_execution_output
type: :bash_code_execution_result
class BetaBashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
type: :bash_code_execution_output
type: :bash_code_execution_result
class BetaBashCodeExecutionToolResultBlock { content, tool_use_id, type }
content: BetaBashCodeExecutionToolResultError { error_code, type } | BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
class BetaBashCodeExecutionToolResultError { error_code, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :bash_code_execution_tool_result_error
class BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
type: :bash_code_execution_output
type: :bash_code_execution_result
type: :bash_code_execution_tool_result
class BetaBashCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }
content: BetaBashCodeExecutionToolResultErrorParam { error_code, type } | BetaBashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
class BetaBashCodeExecutionToolResultErrorParam { error_code, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :bash_code_execution_tool_result_error
class BetaBashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
type: :bash_code_execution_output
type: :bash_code_execution_result
type: :bash_code_execution_tool_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaBashCodeExecutionToolResultError { error_code, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :bash_code_execution_tool_result_error
class BetaBashCodeExecutionToolResultErrorParam { error_code, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :bash_code_execution_tool_result_error
class BetaCacheControlEphemeral { type, ttl }
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCacheCreation { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }
ephemeral_1h_input_tokens: Integer
The number of input tokens used to create the 1 hour cache entry.
ephemeral_5m_input_tokens: Integer
The number of input tokens used to create the 5 minute cache entry.
class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: :char_location
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationConfig { enabled }
class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: :content_block_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: :page_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationsConfigParam { enabled }
class BetaCitationsDelta { citation, type }
citation: BetaCitationCharLocation { cited_text, document_index, document_title, 4 more } | BetaCitationPageLocation { cited_text, document_index, document_title, 4 more } | BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more } | 2 more
class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: :char_location
class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: :page_location
class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: :content_block_location
class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :citations_delta
class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaClearThinking20251015Edit { type, keep }
type: :clear_thinking_20251015
Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed.
class BetaThinkingTurns { type, value }
type: :thinking_turns
class BetaAllThinkingTurns { type }
type: :all
Keep = :all
class BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }
cleared_input_tokens: Integer
Number of input tokens cleared by this edit.
cleared_thinking_turns: Integer
Number of thinking turns that were cleared.
type: :clear_thinking_20251015
The type of context management edit applied.
class BetaClearToolUses20250919Edit { type, clear_at_least, clear_tool_inputs, 3 more }
type: :clear_tool_uses_20250919
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
clear_tool_inputs: bool | Array[String]
Whether to clear all tool inputs (bool) or specific tool inputs to clear (list)
exclude_tools: Array[String]
Tool names whose uses are preserved from clearing
Number of tool uses to retain in the conversation
type: :tool_uses
Condition that triggers the context management strategy
class BetaInputTokensTrigger { type, value }
type: :input_tokens
class BetaToolUsesTrigger { type, value }
type: :tool_uses
class BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type }
cleared_input_tokens: Integer
Number of input tokens cleared by this edit.
cleared_tool_uses: Integer
Number of tool uses that were cleared.
type: :clear_tool_uses_20250919
The type of context management edit applied.
class BetaCodeExecutionOutputBlock { file_id, type }
type: :code_execution_output
class BetaCodeExecutionOutputBlockParam { file_id, type }
type: :code_execution_output
class BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }
type: :code_execution_output
type: :code_execution_result
class BetaCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
type: :code_execution_output
type: :code_execution_result
class BetaCodeExecutionTool20250522 { name, type, allowed_callers, 3 more }
name: :code_execution
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: :code_execution_20250522
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaCodeExecutionTool20250825 { name, type, allowed_callers, 3 more }
name: :code_execution
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: :code_execution_20250825
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaCodeExecutionToolResultBlock { content, tool_use_id, type }
class BetaCodeExecutionToolResultError { error_code, type }
type: :code_execution_tool_result_error
class BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }
type: :code_execution_output
type: :code_execution_result
type: :code_execution_tool_result
BetaCodeExecutionToolResultBlockContent = BetaCodeExecutionToolResultError { error_code, type } | BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }
class BetaCodeExecutionToolResultError { error_code, type }
type: :code_execution_tool_result_error
class BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }
type: :code_execution_output
type: :code_execution_result
class BetaCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }
class BetaCodeExecutionToolResultErrorParam { error_code, type }
type: :code_execution_tool_result_error
class BetaCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
type: :code_execution_output
type: :code_execution_result
type: :code_execution_tool_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaCodeExecutionToolResultBlockParamContent = BetaCodeExecutionToolResultErrorParam { error_code, type } | BetaCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
class BetaCodeExecutionToolResultErrorParam { error_code, type }
type: :code_execution_tool_result_error
class BetaCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
type: :code_execution_output
type: :code_execution_result
class BetaCodeExecutionToolResultError { error_code, type }
type: :code_execution_tool_result_error
BetaCodeExecutionToolResultErrorCode = :invalid_tool_input | :unavailable | :too_many_requests | :execution_time_exceeded
class BetaCodeExecutionToolResultErrorParam { error_code, type }
type: :code_execution_tool_result_error
class BetaContainer { id, expires_at, skills }
Information about the container used in the request (for the code execution tool)
id: String
Identifier for the container used in this request
expires_at: Time
The time at which the container will expire.
Skills loaded in the container
skill_id: String
Skill ID
type: :anthropic | :custom
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
version: String
Skill version or 'latest' for most recent version
class BetaContainerParams { id, skills }
Container parameters with skills to be loaded.
id: String
Container id
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)
version: String
Skill version or 'latest' for most recent version
class BetaContainerUploadBlock { file_id, type }
Response model for a file uploaded to the container.
type: :container_upload
class BetaContainerUploadBlockParam { file_id, type, cache_control }
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.
type: :container_upload
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaContentBlock = BetaTextBlock { citations, text, type } | BetaThinkingBlock { signature, thinking, type } | BetaRedactedThinkingBlock { data, type } | 11 more
Response model for a file uploaded to the container.
class BetaTextBlock { citations, text, type }
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: :char_location
class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: :page_location
class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: :content_block_location
class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :text
class BetaThinkingBlock { signature, thinking, type }
type: :thinking
class BetaRedactedThinkingBlock { data, type }
type: :redacted_thinking
class BetaToolUseBlock { id, input, name, 2 more }
type: :tool_use
Tool invocation directly from the model.
class BetaDirectCaller { type }
Tool invocation directly from the model.
type: :direct
class BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: :code_execution_20250825
class BetaServerToolUseBlock { id, caller_, input, 2 more }
Tool invocation directly from the model.
class BetaDirectCaller { type }
Tool invocation directly from the model.
type: :direct
class BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: :code_execution_20250825
name: :web_search | :web_fetch | :code_execution | 4 more
type: :server_tool_use
class BetaWebSearchToolResultBlock { content, tool_use_id, type }
class BetaWebSearchToolResultError { error_code, type }
type: :web_search_tool_result_error
Array[BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more } ]
type: :web_search_result
type: :web_search_tool_result
class BetaWebFetchToolResultBlock { content, tool_use_id, type }
content: BetaWebFetchToolResultErrorBlock { error_code, type } | BetaWebFetchBlock { content, retrieved_at, type, url }
class BetaWebFetchToolResultErrorBlock { error_code, type }
type: :web_fetch_tool_result_error
class BetaWebFetchBlock { content, retrieved_at, type, url }
Citation configuration for the document
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type }
class BetaBase64PDFSource { data, media_type, type }
media_type: :"application/pdf"
type: :base64
class BetaPlainTextSource { data, media_type, type }
media_type: :"text/plain"
type: :text
title: String
The title of the document
type: :document
retrieved_at: String
ISO 8601 timestamp when the content was retrieved
type: :web_fetch_result
url: String
Fetched content URL
type: :web_fetch_tool_result
class BetaCodeExecutionToolResultBlock { content, tool_use_id, type }
class BetaCodeExecutionToolResultError { error_code, type }
type: :code_execution_tool_result_error
class BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }
type: :code_execution_output
type: :code_execution_result
type: :code_execution_tool_result
class BetaBashCodeExecutionToolResultBlock { content, tool_use_id, type }
content: BetaBashCodeExecutionToolResultError { error_code, type } | BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
class BetaBashCodeExecutionToolResultError { error_code, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :bash_code_execution_tool_result_error
class BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
type: :bash_code_execution_output
type: :bash_code_execution_result
type: :bash_code_execution_tool_result
class BetaTextEditorCodeExecutionToolResultBlock { content, tool_use_id, type }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } | BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } | BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } | BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
class BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :text_editor_code_execution_tool_result_error
class BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more }
file_type: :text | :image | :pdf
type: :text_editor_code_execution_view_result
class BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type }
type: :text_editor_code_execution_create_result
class BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
type: :text_editor_code_execution_str_replace_result
type: :text_editor_code_execution_tool_result
class BetaToolSearchToolResultBlock { content, tool_use_id, type }
content: BetaToolSearchToolResultError { error_code, error_message, type } | BetaToolSearchToolSearchResultBlock { tool_references, type }
class BetaToolSearchToolResultError { error_code, error_message, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | :execution_time_exceeded
type: :tool_search_tool_result_error
class BetaToolSearchToolSearchResultBlock { tool_references, type }
type: :tool_reference
type: :tool_search_tool_search_result
type: :tool_search_tool_result
class BetaMCPToolUseBlock { id, input, name, 2 more }
name: String
The name of the MCP tool
server_name: String
The name of the MCP server
type: :mcp_tool_use
class BetaMCPToolResultBlock { content, is_error, tool_use_id, type }
Array[BetaTextBlock { citations, text, type } ]
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: :char_location
class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: :page_location
class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: :content_block_location
class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :text
type: :mcp_tool_result
class BetaContainerUploadBlock { file_id, type }
Response model for a file uploaded to the container.
type: :container_upload
BetaContentBlockParam = BetaTextBlockParam { text, type, cache_control, citations } | BetaImageBlockParam { source, type, cache_control } | BetaRequestDocumentBlock { source, type, cache_control, 3 more } | 15 more
Regular text content.
class BetaTextBlockParam { text, type, cache_control, citations }
type: :text
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
class BetaBase64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
type: :base64
class BetaURLImageSource { type, url }
type: :url
class BetaFileImageSource { file_id, type }
type: :file
type: :image
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaRequestDocumentBlock { source, type, cache_control, 3 more }
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type } | BetaContentBlockSource { content, type } | 2 more
class BetaBase64PDFSource { data, media_type, type }
media_type: :"application/pdf"
type: :base64
class BetaPlainTextSource { data, media_type, type }
media_type: :"text/plain"
type: :text
class BetaContentBlockSource { content, type }
class BetaTextBlockParam { text, type, cache_control, citations }
type: :text
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
class BetaBase64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
type: :base64
class BetaURLImageSource { type, url }
type: :url
class BetaFileImageSource { file_id, type }
type: :file
type: :image
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: :content
class BetaURLPDFSource { type, url }
type: :url
class BetaFileDocumentSource { file_id, type }
type: :file
type: :document
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaSearchResultBlockParam { content, source, title, 3 more }
type: :text
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :search_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaThinkingBlockParam { signature, thinking, type }
type: :thinking
class BetaRedactedThinkingBlockParam { data, type }
type: :redacted_thinking
class BetaToolUseBlockParam { id, input, name, 3 more }
type: :tool_use
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Tool invocation directly from the model.
class BetaDirectCaller { type }
Tool invocation directly from the model.
type: :direct
class BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: :code_execution_20250825
class BetaToolResultBlockParam { tool_use_id, type, cache_control, 2 more }
type: :tool_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
content: String | Array[BetaTextBlockParam { text, type, cache_control, citations } | BetaImageBlockParam { source, type, cache_control } | BetaSearchResultBlockParam { content, source, title, 3 more } | 2 more]
Array[BetaTextBlockParam { text, type, cache_control, citations } | BetaImageBlockParam { source, type, cache_control } | BetaSearchResultBlockParam { content, source, title, 3 more } | 2 more]
class BetaTextBlockParam { text, type, cache_control, citations }
type: :text
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
class BetaBase64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
type: :base64
class BetaURLImageSource { type, url }
type: :url
class BetaFileImageSource { file_id, type }
type: :file
type: :image
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaSearchResultBlockParam { content, source, title, 3 more }
type: :text
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :search_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaRequestDocumentBlock { source, type, cache_control, 3 more }
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type } | BetaContentBlockSource { content, type } | 2 more
class BetaBase64PDFSource { data, media_type, type }
media_type: :"application/pdf"
type: :base64
class BetaPlainTextSource { data, media_type, type }
media_type: :"text/plain"
type: :text
class BetaContentBlockSource { content, type }
class BetaTextBlockParam { text, type, cache_control, citations }
type: :text
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
class BetaBase64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
type: :base64
class BetaURLImageSource { type, url }
type: :url
class BetaFileImageSource { file_id, type }
type: :file
type: :image
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: :content
class BetaURLPDFSource { type, url }
type: :url
class BetaFileDocumentSource { file_id, type }
type: :file
type: :document
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaToolReferenceBlockParam { tool_name, type, cache_control }
Tool reference block that can be included in tool_result content.
type: :tool_reference
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaServerToolUseBlockParam { id, input, name, 3 more }
name: :web_search | :web_fetch | :code_execution | 4 more
type: :server_tool_use
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Tool invocation directly from the model.
class BetaDirectCaller { type }
Tool invocation directly from the model.
type: :direct
class BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: :code_execution_20250825
class BetaWebSearchToolResultBlockParam { content, tool_use_id, type, cache_control }
Array[BetaWebSearchResultBlockParam { encrypted_content, title, type, 2 more } ]
type: :web_search_result
class BetaWebSearchToolRequestError { error_code, type }
type: :web_search_tool_result_error
type: :web_search_tool_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaWebFetchToolResultBlockParam { content, tool_use_id, type, cache_control }
content: BetaWebFetchToolResultErrorBlockParam { error_code, type } | BetaWebFetchBlockParam { content, type, url, retrieved_at }
class BetaWebFetchToolResultErrorBlockParam { error_code, type }
type: :web_fetch_tool_result_error
class BetaWebFetchBlockParam { content, type, url, retrieved_at }
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type } | BetaContentBlockSource { content, type } | 2 more
class BetaBase64PDFSource { data, media_type, type }
media_type: :"application/pdf"
type: :base64
class BetaPlainTextSource { data, media_type, type }
media_type: :"text/plain"
type: :text
class BetaContentBlockSource { content, type }
class BetaTextBlockParam { text, type, cache_control, citations }
type: :text
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
class BetaBase64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
type: :base64
class BetaURLImageSource { type, url }
type: :url
class BetaFileImageSource { file_id, type }
type: :file
type: :image
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: :content
class BetaURLPDFSource { type, url }
type: :url
class BetaFileDocumentSource { file_id, type }
type: :file
type: :document
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: :web_fetch_result
url: String
Fetched content URL
retrieved_at: String
ISO 8601 timestamp when the content was retrieved
type: :web_fetch_tool_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }
class BetaCodeExecutionToolResultErrorParam { error_code, type }
type: :code_execution_tool_result_error
class BetaCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
type: :code_execution_output
type: :code_execution_result
type: :code_execution_tool_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaBashCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }
content: BetaBashCodeExecutionToolResultErrorParam { error_code, type } | BetaBashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
class BetaBashCodeExecutionToolResultErrorParam { error_code, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :bash_code_execution_tool_result_error
class BetaBashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
type: :bash_code_execution_output
type: :bash_code_execution_result
type: :bash_code_execution_tool_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaTextEditorCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }
content: BetaTextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message } | BetaTextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more } | BetaTextEditorCodeExecutionCreateResultBlockParam { is_file_update, type } | BetaTextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }
class BetaTextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :text_editor_code_execution_tool_result_error
class BetaTextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more }
file_type: :text | :image | :pdf
type: :text_editor_code_execution_view_result
class BetaTextEditorCodeExecutionCreateResultBlockParam { is_file_update, type }
type: :text_editor_code_execution_create_result
class BetaTextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }
type: :text_editor_code_execution_str_replace_result
type: :text_editor_code_execution_tool_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaToolSearchToolResultBlockParam { content, tool_use_id, type, cache_control }
content: BetaToolSearchToolResultErrorParam { error_code, type } | BetaToolSearchToolSearchResultBlockParam { tool_references, type }
class BetaToolSearchToolResultErrorParam { error_code, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | :execution_time_exceeded
type: :tool_search_tool_result_error
class BetaToolSearchToolSearchResultBlockParam { tool_references, type }
type: :tool_reference
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: :tool_search_tool_search_result
type: :tool_search_tool_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaMCPToolUseBlockParam { id, input, name, 3 more }
server_name: String
The name of the MCP server
type: :mcp_tool_use
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaRequestMCPToolResultBlockParam { tool_use_id, type, cache_control, 2 more }
type: :mcp_tool_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Array[BetaTextBlockParam { text, type, cache_control, citations } ]
type: :text
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaContainerUploadBlockParam { file_id, type, cache_control }
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.
type: :container_upload
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaContentBlockSource { content, type }
class BetaTextBlockParam { text, type, cache_control, citations }
type: :text
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
class BetaBase64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
type: :base64
class BetaURLImageSource { type, url }
type: :url
class BetaFileImageSource { file_id, type }
type: :file
type: :image
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: :content
BetaContentBlockSourceContent = BetaTextBlockParam { text, type, cache_control, citations } | BetaImageBlockParam { source, type, cache_control }
class BetaTextBlockParam { text, type, cache_control, citations }
type: :text
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
class BetaBase64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
type: :base64
class BetaURLImageSource { type, url }
type: :url
class BetaFileImageSource { file_id, type }
type: :file
type: :image
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaContextManagementConfig { edits }
edits: Array[BetaClearToolUses20250919Edit { type, clear_at_least, clear_tool_inputs, 3 more } | BetaClearThinking20251015Edit { type, keep } ]
List of context management edits to apply
class BetaClearToolUses20250919Edit { type, clear_at_least, clear_tool_inputs, 3 more }
type: :clear_tool_uses_20250919
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
clear_tool_inputs: bool | Array[String]
Whether to clear all tool inputs (bool) or specific tool inputs to clear (list)
exclude_tools: Array[String]
Tool names whose uses are preserved from clearing
Number of tool uses to retain in the conversation
type: :tool_uses
Condition that triggers the context management strategy
class BetaInputTokensTrigger { type, value }
type: :input_tokens
class BetaToolUsesTrigger { type, value }
type: :tool_uses
class BetaClearThinking20251015Edit { type, keep }
type: :clear_thinking_20251015
Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed.
class BetaThinkingTurns { type, value }
type: :thinking_turns
class BetaAllThinkingTurns { type }
type: :all
Keep = :all
class BetaContextManagementResponse { applied_edits }
applied_edits: Array[BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } | BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type } ]
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type }
cleared_input_tokens: Integer
Number of input tokens cleared by this edit.
cleared_tool_uses: Integer
Number of tool uses that were cleared.
type: :clear_tool_uses_20250919
The type of context management edit applied.
class BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }
cleared_input_tokens: Integer
Number of input tokens cleared by this edit.
cleared_thinking_turns: Integer
Number of thinking turns that were cleared.
type: :clear_thinking_20251015
The type of context management edit applied.
class BetaCountTokensContextManagementResponse { original_input_tokens }
original_input_tokens: Integer
The original token count before context management was applied
class BetaDirectCaller { type }
Tool invocation directly from the model.
type: :direct
class BetaDocumentBlock { citations, source, title, type }
Citation configuration for the document
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type }
class BetaBase64PDFSource { data, media_type, type }
media_type: :"application/pdf"
type: :base64
class BetaPlainTextSource { data, media_type, type }
media_type: :"text/plain"
type: :text
title: String
The title of the document
type: :document
class BetaFileDocumentSource { file_id, type }
type: :file
class BetaFileImageSource { file_id, type }
type: :file
class BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
class BetaBase64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
type: :base64
class BetaURLImageSource { type, url }
type: :url
class BetaFileImageSource { file_id, type }
type: :file
type: :image
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaInputJSONDelta { partial_json, type }
type: :input_json_delta
class BetaInputTokensClearAtLeast { type, value }
type: :input_tokens
class BetaInputTokensTrigger { type, value }
type: :input_tokens
class BetaJSONOutputFormat { schema, type }
schema: Hash[Symbol, untyped]
The JSON schema of the format
type: :json_schema
class BetaMCPToolConfig { defer_loading, enabled }
Configuration for a specific tool in an MCP toolset.
class BetaMCPToolDefaultConfig { defer_loading, enabled }
Default configuration for tools in an MCP toolset.
class BetaMCPToolResultBlock { content, is_error, tool_use_id, type }
Array[BetaTextBlock { citations, text, type } ]
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: :char_location
class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: :page_location
class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: :content_block_location
class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :text
type: :mcp_tool_result
class BetaMCPToolUseBlock { id, input, name, 2 more }
name: String
The name of the MCP tool
server_name: String
The name of the MCP server
type: :mcp_tool_use
class BetaMCPToolUseBlockParam { id, input, name, 3 more }
server_name: String
The name of the MCP server
type: :mcp_tool_use
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaMCPToolset { mcp_server_name, type, cache_control, 2 more }
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
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Configuration overrides for specific tools, keyed by tool name
Default configuration applied to all tools from this server
class BetaMemoryTool20250818 { name, type, allowed_callers, 4 more }
name: :memory
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: :memory_20250818
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
BetaMemoryTool20250818Command = BetaMemoryTool20250818ViewCommand { command, path, view_range } | BetaMemoryTool20250818CreateCommand { command, file_text, path } | BetaMemoryTool20250818StrReplaceCommand { command, new_str, old_str, path } | 3 more
class BetaMemoryTool20250818ViewCommand { command, path, view_range }
command: :view
Command type identifier
path: String
Path to directory or file to view
view_range: Array[Integer]
Optional line range for viewing specific lines
class BetaMemoryTool20250818CreateCommand { command, file_text, path }
command: :create
Command type identifier
file_text: String
Content to write to the file
path: String
Path where the file should be created
class BetaMemoryTool20250818StrReplaceCommand { command, new_str, old_str, path }
command: :str_replace
Command type identifier
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
class BetaMemoryTool20250818InsertCommand { command, insert_line, insert_text, path }
command: :insert
Command type identifier
insert_line: Integer
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
class BetaMemoryTool20250818DeleteCommand { command, path }
command: :delete
Command type identifier
path: String
Path to the file or directory to delete
class BetaMemoryTool20250818RenameCommand { command, new_path, old_path }
command: :rename
Command type identifier
new_path: String
New path for the file or directory
old_path: String
Current path of the file or directory
class BetaMemoryTool20250818CreateCommand { command, file_text, path }
command: :create
Command type identifier
file_text: String
Content to write to the file
path: String
Path where the file should be created
class BetaMemoryTool20250818DeleteCommand { command, path }
command: :delete
Command type identifier
path: String
Path to the file or directory to delete
class BetaMemoryTool20250818InsertCommand { command, insert_line, insert_text, path }
command: :insert
Command type identifier
insert_line: Integer
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
class BetaMemoryTool20250818RenameCommand { command, new_path, old_path }
command: :rename
Command type identifier
new_path: String
New path for the file or directory
old_path: String
Current path of the file or directory
class BetaMemoryTool20250818StrReplaceCommand { command, new_str, old_str, path }
command: :str_replace
Command type identifier
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
class BetaMemoryTool20250818ViewCommand { command, path, view_range }
command: :view
Command type identifier
path: String
Path to directory or file to view
view_range: Array[Integer]
Optional line range for viewing specific lines
class BetaMessage { id, container, content, 7 more }
id: String
Unique object identifier.
The format and length of IDs may change over time.
Information about the container used in the request (for the code execution tool)
id: String
Identifier for the container used in this request
expires_at: Time
The time at which the container will expire.
Skills loaded in the container
skill_id: String
Skill ID
type: :anthropic | :custom
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
version: String
Skill version or 'latest' for most recent version
Content generated by the model.
This is an array of content blocks, each of which has a type that determines its shape.
Example:
[{"type": "text", "text": "Hi, I'm Claude."}]
If the request input messages ended with an assistant turn, then the response content will continue directly from that last turn. You can use this to constrain the model's output.
For example, if the input messages were:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("}
]
Then the response content might be:
[{"type": "text", "text": "B)"}]
class BetaTextBlock { citations, text, type }
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: :char_location
class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: :page_location
class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: :content_block_location
class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :text
class BetaThinkingBlock { signature, thinking, type }
type: :thinking
class BetaRedactedThinkingBlock { data, type }
type: :redacted_thinking
class BetaToolUseBlock { id, input, name, 2 more }
type: :tool_use
Tool invocation directly from the model.
class BetaDirectCaller { type }
Tool invocation directly from the model.
type: :direct
class BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: :code_execution_20250825
class BetaServerToolUseBlock { id, caller_, input, 2 more }
Tool invocation directly from the model.
class BetaDirectCaller { type }
Tool invocation directly from the model.
type: :direct
class BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: :code_execution_20250825
name: :web_search | :web_fetch | :code_execution | 4 more
type: :server_tool_use
class BetaWebSearchToolResultBlock { content, tool_use_id, type }
class BetaWebSearchToolResultError { error_code, type }
type: :web_search_tool_result_error
Array[BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more } ]
type: :web_search_result
type: :web_search_tool_result
class BetaWebFetchToolResultBlock { content, tool_use_id, type }
content: BetaWebFetchToolResultErrorBlock { error_code, type } | BetaWebFetchBlock { content, retrieved_at, type, url }
class BetaWebFetchToolResultErrorBlock { error_code, type }
type: :web_fetch_tool_result_error
class BetaWebFetchBlock { content, retrieved_at, type, url }
Citation configuration for the document
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type }
class BetaBase64PDFSource { data, media_type, type }
media_type: :"application/pdf"
type: :base64
class BetaPlainTextSource { data, media_type, type }
media_type: :"text/plain"
type: :text
title: String
The title of the document
type: :document
retrieved_at: String
ISO 8601 timestamp when the content was retrieved
type: :web_fetch_result
url: String
Fetched content URL
type: :web_fetch_tool_result
class BetaCodeExecutionToolResultBlock { content, tool_use_id, type }
class BetaCodeExecutionToolResultError { error_code, type }
type: :code_execution_tool_result_error
class BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }
type: :code_execution_output
type: :code_execution_result
type: :code_execution_tool_result
class BetaBashCodeExecutionToolResultBlock { content, tool_use_id, type }
content: BetaBashCodeExecutionToolResultError { error_code, type } | BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
class BetaBashCodeExecutionToolResultError { error_code, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :bash_code_execution_tool_result_error
class BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
type: :bash_code_execution_output
type: :bash_code_execution_result
type: :bash_code_execution_tool_result
class BetaTextEditorCodeExecutionToolResultBlock { content, tool_use_id, type }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } | BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } | BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } | BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
class BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :text_editor_code_execution_tool_result_error
class BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more }
file_type: :text | :image | :pdf
type: :text_editor_code_execution_view_result
class BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type }
type: :text_editor_code_execution_create_result
class BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
type: :text_editor_code_execution_str_replace_result
type: :text_editor_code_execution_tool_result
class BetaToolSearchToolResultBlock { content, tool_use_id, type }
content: BetaToolSearchToolResultError { error_code, error_message, type } | BetaToolSearchToolSearchResultBlock { tool_references, type }
class BetaToolSearchToolResultError { error_code, error_message, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | :execution_time_exceeded
type: :tool_search_tool_result_error
class BetaToolSearchToolSearchResultBlock { tool_references, type }
type: :tool_reference
type: :tool_search_tool_search_result
type: :tool_search_tool_result
class BetaMCPToolUseBlock { id, input, name, 2 more }
name: String
The name of the MCP tool
server_name: String
The name of the MCP server
type: :mcp_tool_use
class BetaMCPToolResultBlock { content, is_error, tool_use_id, type }
Array[BetaTextBlock { citations, text, type } ]
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: :char_location
class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: :page_location
class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: :content_block_location
class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :text
type: :mcp_tool_result
class BetaContainerUploadBlock { file_id, type }
Response model for a file uploaded to the container.
type: :container_upload
Context management response.
Information about context management strategies applied during the request.
applied_edits: Array[BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } | BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type } ]
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type }
cleared_input_tokens: Integer
Number of input tokens cleared by this edit.
cleared_tool_uses: Integer
Number of tool uses that were cleared.
type: :clear_tool_uses_20250919
The type of context management edit applied.
class BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }
cleared_input_tokens: Integer
Number of input tokens cleared by this edit.
cleared_thinking_turns: Integer
Number of thinking turns that were cleared.
type: :clear_thinking_20251015
The type of context management edit applied.
The model that will complete your prompt.
See models for additional details and options.
:"claude-opus-4-5-20251101" | :"claude-opus-4-5" | :"claude-3-7-sonnet-latest" | 17 more
The model that will complete your prompt.
See models for additional details and options.
:"claude-opus-4-5-20251101"
Premium model combining maximum intelligence with practical performance
:"claude-opus-4-5"
Premium model combining maximum intelligence with practical performance
:"claude-3-7-sonnet-latest"
High-performance model with early extended thinking
:"claude-3-7-sonnet-20250219"
High-performance model with early extended thinking
:"claude-3-5-haiku-latest"
Fastest and most compact model for near-instant responsiveness
:"claude-3-5-haiku-20241022"
Our fastest model
:"claude-haiku-4-5"
Hybrid model, capable of near-instant responses and extended thinking
:"claude-haiku-4-5-20251001"
Hybrid model, capable of near-instant responses and extended thinking
:"claude-sonnet-4-20250514"
High-performance model with extended thinking
:"claude-sonnet-4-0"
High-performance model with extended thinking
:"claude-4-sonnet-20250514"
High-performance model with extended thinking
:"claude-sonnet-4-5"
Our best model for real-world agents and coding
:"claude-sonnet-4-5-20250929"
Our best model for real-world agents and coding
:"claude-opus-4-0"
Our most capable model
:"claude-opus-4-20250514"
Our most capable model
:"claude-4-opus-20250514"
Our most capable model
:"claude-opus-4-1-20250805"
Our most capable model
:"claude-3-opus-latest"
Excels at writing and complex tasks
:"claude-3-opus-20240229"
Excels at writing and complex tasks
:"claude-3-haiku-20240307"
Our previous most fast and cost-effective
role: :assistant
Conversational role of the generated message.
This will always be "assistant".
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
stop_sequence: String
Which custom stop sequence was generated, if any.
This value will be a non-null string if one of your custom stop sequences was generated.
type: :message
Object type.
For Messages, this is always "message".
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
Breakdown of cached tokens by TTL
ephemeral_1h_input_tokens: Integer
The number of input tokens used to create the 1 hour cache entry.
ephemeral_5m_input_tokens: Integer
The number of input tokens used to create the 5 minute cache entry.
cache_creation_input_tokens: Integer
The number of input tokens used to create the cache entry.
cache_read_input_tokens: Integer
The number of input tokens read from the cache.
input_tokens: Integer
The number of input tokens which were used.
output_tokens: Integer
The number of output tokens which were used.
The number of server tool requests.
web_fetch_requests: Integer
The number of web fetch tool requests.
web_search_requests: Integer
The number of web search tool requests.
service_tier: :standard | :priority | :batch
If the request used the priority, standard, or batch tier.
class BetaMessageDeltaUsage { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more }
cache_creation_input_tokens: Integer
The cumulative number of input tokens used to create the cache entry.
cache_read_input_tokens: Integer
The cumulative number of input tokens read from the cache.
input_tokens: Integer
The cumulative number of input tokens which were used.
output_tokens: Integer
The cumulative number of output tokens which were used.
The number of server tool requests.
web_fetch_requests: Integer
The number of web fetch tool requests.
web_search_requests: Integer
The number of web search tool requests.
class BetaMessageParam { content, role }
Array[BetaContentBlockParam]
class BetaTextBlockParam { text, type, cache_control, citations }
type: :text
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
class BetaBase64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
type: :base64
class BetaURLImageSource { type, url }
type: :url
class BetaFileImageSource { file_id, type }
type: :file
type: :image
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaRequestDocumentBlock { source, type, cache_control, 3 more }
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type } | BetaContentBlockSource { content, type } | 2 more
class BetaBase64PDFSource { data, media_type, type }
media_type: :"application/pdf"
type: :base64
class BetaPlainTextSource { data, media_type, type }
media_type: :"text/plain"
type: :text
class BetaContentBlockSource { content, type }
class BetaTextBlockParam { text, type, cache_control, citations }
type: :text
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
class BetaBase64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
type: :base64
class BetaURLImageSource { type, url }
type: :url
class BetaFileImageSource { file_id, type }
type: :file
type: :image
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: :content
class BetaURLPDFSource { type, url }
type: :url
class BetaFileDocumentSource { file_id, type }
type: :file
type: :document
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaSearchResultBlockParam { content, source, title, 3 more }
type: :text
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :search_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaThinkingBlockParam { signature, thinking, type }
type: :thinking
class BetaRedactedThinkingBlockParam { data, type }
type: :redacted_thinking
class BetaToolUseBlockParam { id, input, name, 3 more }
type: :tool_use
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Tool invocation directly from the model.
class BetaDirectCaller { type }
Tool invocation directly from the model.
type: :direct
class BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: :code_execution_20250825
class BetaToolResultBlockParam { tool_use_id, type, cache_control, 2 more }
type: :tool_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
content: String | Array[BetaTextBlockParam { text, type, cache_control, citations } | BetaImageBlockParam { source, type, cache_control } | BetaSearchResultBlockParam { content, source, title, 3 more } | 2 more]
Array[BetaTextBlockParam { text, type, cache_control, citations } | BetaImageBlockParam { source, type, cache_control } | BetaSearchResultBlockParam { content, source, title, 3 more } | 2 more]
class BetaTextBlockParam { text, type, cache_control, citations }
type: :text
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
class BetaBase64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
type: :base64
class BetaURLImageSource { type, url }
type: :url
class BetaFileImageSource { file_id, type }
type: :file
type: :image
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaSearchResultBlockParam { content, source, title, 3 more }
type: :text
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :search_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaRequestDocumentBlock { source, type, cache_control, 3 more }
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type } | BetaContentBlockSource { content, type } | 2 more
class BetaBase64PDFSource { data, media_type, type }
media_type: :"application/pdf"
type: :base64
class BetaPlainTextSource { data, media_type, type }
media_type: :"text/plain"
type: :text
class BetaContentBlockSource { content, type }
class BetaTextBlockParam { text, type, cache_control, citations }
type: :text
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
class BetaBase64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
type: :base64
class BetaURLImageSource { type, url }
type: :url
class BetaFileImageSource { file_id, type }
type: :file
type: :image
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: :content
class BetaURLPDFSource { type, url }
type: :url
class BetaFileDocumentSource { file_id, type }
type: :file
type: :document
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaToolReferenceBlockParam { tool_name, type, cache_control }
Tool reference block that can be included in tool_result content.
type: :tool_reference
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaServerToolUseBlockParam { id, input, name, 3 more }
name: :web_search | :web_fetch | :code_execution | 4 more
type: :server_tool_use
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Tool invocation directly from the model.
class BetaDirectCaller { type }
Tool invocation directly from the model.
type: :direct
class BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: :code_execution_20250825
class BetaWebSearchToolResultBlockParam { content, tool_use_id, type, cache_control }
Array[BetaWebSearchResultBlockParam { encrypted_content, title, type, 2 more } ]
type: :web_search_result
class BetaWebSearchToolRequestError { error_code, type }
type: :web_search_tool_result_error
type: :web_search_tool_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaWebFetchToolResultBlockParam { content, tool_use_id, type, cache_control }
content: BetaWebFetchToolResultErrorBlockParam { error_code, type } | BetaWebFetchBlockParam { content, type, url, retrieved_at }
class BetaWebFetchToolResultErrorBlockParam { error_code, type }
type: :web_fetch_tool_result_error
class BetaWebFetchBlockParam { content, type, url, retrieved_at }
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type } | BetaContentBlockSource { content, type } | 2 more
class BetaBase64PDFSource { data, media_type, type }
media_type: :"application/pdf"
type: :base64
class BetaPlainTextSource { data, media_type, type }
media_type: :"text/plain"
type: :text
class BetaContentBlockSource { content, type }
class BetaTextBlockParam { text, type, cache_control, citations }
type: :text
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
class BetaBase64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
type: :base64
class BetaURLImageSource { type, url }
type: :url
class BetaFileImageSource { file_id, type }
type: :file
type: :image
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: :content
class BetaURLPDFSource { type, url }
type: :url
class BetaFileDocumentSource { file_id, type }
type: :file
type: :document
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: :web_fetch_result
url: String
Fetched content URL
retrieved_at: String
ISO 8601 timestamp when the content was retrieved
type: :web_fetch_tool_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }
class BetaCodeExecutionToolResultErrorParam { error_code, type }
type: :code_execution_tool_result_error
class BetaCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
type: :code_execution_output
type: :code_execution_result
type: :code_execution_tool_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaBashCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }
content: BetaBashCodeExecutionToolResultErrorParam { error_code, type } | BetaBashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
class BetaBashCodeExecutionToolResultErrorParam { error_code, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :bash_code_execution_tool_result_error
class BetaBashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
type: :bash_code_execution_output
type: :bash_code_execution_result
type: :bash_code_execution_tool_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaTextEditorCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }
content: BetaTextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message } | BetaTextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more } | BetaTextEditorCodeExecutionCreateResultBlockParam { is_file_update, type } | BetaTextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }
class BetaTextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :text_editor_code_execution_tool_result_error
class BetaTextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more }
file_type: :text | :image | :pdf
type: :text_editor_code_execution_view_result
class BetaTextEditorCodeExecutionCreateResultBlockParam { is_file_update, type }
type: :text_editor_code_execution_create_result
class BetaTextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }
type: :text_editor_code_execution_str_replace_result
type: :text_editor_code_execution_tool_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaToolSearchToolResultBlockParam { content, tool_use_id, type, cache_control }
content: BetaToolSearchToolResultErrorParam { error_code, type } | BetaToolSearchToolSearchResultBlockParam { tool_references, type }
class BetaToolSearchToolResultErrorParam { error_code, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | :execution_time_exceeded
type: :tool_search_tool_result_error
class BetaToolSearchToolSearchResultBlockParam { tool_references, type }
type: :tool_reference
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: :tool_search_tool_search_result
type: :tool_search_tool_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaMCPToolUseBlockParam { id, input, name, 3 more }
server_name: String
The name of the MCP server
type: :mcp_tool_use
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaRequestMCPToolResultBlockParam { tool_use_id, type, cache_control, 2 more }
type: :mcp_tool_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Array[BetaTextBlockParam { text, type, cache_control, citations } ]
type: :text
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaContainerUploadBlockParam { file_id, type, cache_control }
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.
type: :container_upload
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
role: :user | :assistant
class BetaMessageTokensCount { context_management, input_tokens }
Information about context management applied to the message.
original_input_tokens: Integer
The original token count before context management was applied
input_tokens: Integer
The total number of tokens across the provided list of messages, system prompt, and tools.
class BetaMetadata { user_id }
user_id: String
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.
class BetaOutputConfig { effort }
effort: :low | :medium | :high
All possible effort levels.
class BetaPlainTextSource { data, media_type, type }
media_type: :"text/plain"
type: :text
BetaRawContentBlockDelta = BetaTextDelta { text, type } | BetaInputJSONDelta { partial_json, type } | BetaCitationsDelta { citation, type } | 2 more
class BetaTextDelta { text, type }
type: :text_delta
class BetaInputJSONDelta { partial_json, type }
type: :input_json_delta
class BetaCitationsDelta { citation, type }
citation: BetaCitationCharLocation { cited_text, document_index, document_title, 4 more } | BetaCitationPageLocation { cited_text, document_index, document_title, 4 more } | BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more } | 2 more
class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: :char_location
class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: :page_location
class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: :content_block_location
class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :citations_delta
class BetaThinkingDelta { thinking, type }
type: :thinking_delta
class BetaSignatureDelta { signature, type }
type: :signature_delta
class BetaRawContentBlockDeltaEvent { delta, index, type }
class BetaTextDelta { text, type }
type: :text_delta
class BetaInputJSONDelta { partial_json, type }
type: :input_json_delta
class BetaCitationsDelta { citation, type }
citation: BetaCitationCharLocation { cited_text, document_index, document_title, 4 more } | BetaCitationPageLocation { cited_text, document_index, document_title, 4 more } | BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more } | 2 more
class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: :char_location
class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: :page_location
class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: :content_block_location
class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :citations_delta
class BetaThinkingDelta { thinking, type }
type: :thinking_delta
class BetaSignatureDelta { signature, type }
type: :signature_delta
type: :content_block_delta
class BetaRawContentBlockStartEvent { content_block, index, type }
content_block: BetaTextBlock { citations, text, type } | BetaThinkingBlock { signature, thinking, type } | BetaRedactedThinkingBlock { data, type } | 11 more
Response model for a file uploaded to the container.
class BetaTextBlock { citations, text, type }
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: :char_location
class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: :page_location
class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: :content_block_location
class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :text
class BetaThinkingBlock { signature, thinking, type }
type: :thinking
class BetaRedactedThinkingBlock { data, type }
type: :redacted_thinking
class BetaToolUseBlock { id, input, name, 2 more }
type: :tool_use
Tool invocation directly from the model.
class BetaDirectCaller { type }
Tool invocation directly from the model.
type: :direct
class BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: :code_execution_20250825
class BetaServerToolUseBlock { id, caller_, input, 2 more }
Tool invocation directly from the model.
class BetaDirectCaller { type }
Tool invocation directly from the model.
type: :direct
class BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: :code_execution_20250825
name: :web_search | :web_fetch | :code_execution | 4 more
type: :server_tool_use
class BetaWebSearchToolResultBlock { content, tool_use_id, type }
class BetaWebSearchToolResultError { error_code, type }
type: :web_search_tool_result_error
Array[BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more } ]
type: :web_search_result
type: :web_search_tool_result
class BetaWebFetchToolResultBlock { content, tool_use_id, type }
content: BetaWebFetchToolResultErrorBlock { error_code, type } | BetaWebFetchBlock { content, retrieved_at, type, url }
class BetaWebFetchToolResultErrorBlock { error_code, type }
type: :web_fetch_tool_result_error
class BetaWebFetchBlock { content, retrieved_at, type, url }
Citation configuration for the document
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type }
class BetaBase64PDFSource { data, media_type, type }
media_type: :"application/pdf"
type: :base64
class BetaPlainTextSource { data, media_type, type }
media_type: :"text/plain"
type: :text
title: String
The title of the document
type: :document
retrieved_at: String
ISO 8601 timestamp when the content was retrieved
type: :web_fetch_result
url: String
Fetched content URL
type: :web_fetch_tool_result
class BetaCodeExecutionToolResultBlock { content, tool_use_id, type }
class BetaCodeExecutionToolResultError { error_code, type }
type: :code_execution_tool_result_error
class BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }
type: :code_execution_output
type: :code_execution_result
type: :code_execution_tool_result
class BetaBashCodeExecutionToolResultBlock { content, tool_use_id, type }
content: BetaBashCodeExecutionToolResultError { error_code, type } | BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
class BetaBashCodeExecutionToolResultError { error_code, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :bash_code_execution_tool_result_error
class BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
type: :bash_code_execution_output
type: :bash_code_execution_result
type: :bash_code_execution_tool_result
class BetaTextEditorCodeExecutionToolResultBlock { content, tool_use_id, type }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } | BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } | BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } | BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
class BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :text_editor_code_execution_tool_result_error
class BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more }
file_type: :text | :image | :pdf
type: :text_editor_code_execution_view_result
class BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type }
type: :text_editor_code_execution_create_result
class BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
type: :text_editor_code_execution_str_replace_result
type: :text_editor_code_execution_tool_result
class BetaToolSearchToolResultBlock { content, tool_use_id, type }
content: BetaToolSearchToolResultError { error_code, error_message, type } | BetaToolSearchToolSearchResultBlock { tool_references, type }
class BetaToolSearchToolResultError { error_code, error_message, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | :execution_time_exceeded
type: :tool_search_tool_result_error
class BetaToolSearchToolSearchResultBlock { tool_references, type }
type: :tool_reference
type: :tool_search_tool_search_result
type: :tool_search_tool_result
class BetaMCPToolUseBlock { id, input, name, 2 more }
name: String
The name of the MCP tool
server_name: String
The name of the MCP server
type: :mcp_tool_use
class BetaMCPToolResultBlock { content, is_error, tool_use_id, type }
Array[BetaTextBlock { citations, text, type } ]
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: :char_location
class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: :page_location
class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: :content_block_location
class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :text
type: :mcp_tool_result
class BetaContainerUploadBlock { file_id, type }
Response model for a file uploaded to the container.
type: :container_upload
type: :content_block_start
class BetaRawContentBlockStopEvent { index, type }
type: :content_block_stop
class BetaRawMessageDeltaEvent { context_management, delta, type, usage }
Information about context management strategies applied during the request
applied_edits: Array[BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } | BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type } ]
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type }
cleared_input_tokens: Integer
Number of input tokens cleared by this edit.
cleared_tool_uses: Integer
Number of tool uses that were cleared.
type: :clear_tool_uses_20250919
The type of context management edit applied.
class BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }
cleared_input_tokens: Integer
Number of input tokens cleared by this edit.
cleared_thinking_turns: Integer
Number of thinking turns that were cleared.
type: :clear_thinking_20251015
The type of context management edit applied.
delta: { container, stop_reason, stop_sequence}
Information about the container used in the request (for the code execution tool)
id: String
Identifier for the container used in this request
expires_at: Time
The time at which the container will expire.
Skills loaded in the container
skill_id: String
Skill ID
type: :anthropic | :custom
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
version: String
Skill version or 'latest' for most recent version
type: :message_delta
usage: BetaMessageDeltaUsage { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more }
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: Integer
The cumulative number of input tokens used to create the cache entry.
cache_read_input_tokens: Integer
The cumulative number of input tokens read from the cache.
input_tokens: Integer
The cumulative number of input tokens which were used.
output_tokens: Integer
The cumulative number of output tokens which were used.
The number of server tool requests.
web_fetch_requests: Integer
The number of web fetch tool requests.
web_search_requests: Integer
The number of web search tool requests.
class BetaRawMessageStartEvent { message, type }
id: String
Unique object identifier.
The format and length of IDs may change over time.
Information about the container used in the request (for the code execution tool)
id: String
Identifier for the container used in this request
expires_at: Time
The time at which the container will expire.
Skills loaded in the container
skill_id: String
Skill ID
type: :anthropic | :custom
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
version: String
Skill version or 'latest' for most recent version
Content generated by the model.
This is an array of content blocks, each of which has a type that determines its shape.
Example:
[{"type": "text", "text": "Hi, I'm Claude."}]
If the request input messages ended with an assistant turn, then the response content will continue directly from that last turn. You can use this to constrain the model's output.
For example, if the input messages were:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("}
]
Then the response content might be:
[{"type": "text", "text": "B)"}]
class BetaTextBlock { citations, text, type }
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: :char_location
class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: :page_location
class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: :content_block_location
class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :text
class BetaThinkingBlock { signature, thinking, type }
type: :thinking
class BetaRedactedThinkingBlock { data, type }
type: :redacted_thinking
class BetaToolUseBlock { id, input, name, 2 more }
type: :tool_use
Tool invocation directly from the model.
class BetaDirectCaller { type }
Tool invocation directly from the model.
type: :direct
class BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: :code_execution_20250825
class BetaServerToolUseBlock { id, caller_, input, 2 more }
Tool invocation directly from the model.
class BetaDirectCaller { type }
Tool invocation directly from the model.
type: :direct
class BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: :code_execution_20250825
name: :web_search | :web_fetch | :code_execution | 4 more
type: :server_tool_use
class BetaWebSearchToolResultBlock { content, tool_use_id, type }
class BetaWebSearchToolResultError { error_code, type }
type: :web_search_tool_result_error
Array[BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more } ]
type: :web_search_result
type: :web_search_tool_result
class BetaWebFetchToolResultBlock { content, tool_use_id, type }
content: BetaWebFetchToolResultErrorBlock { error_code, type } | BetaWebFetchBlock { content, retrieved_at, type, url }
class BetaWebFetchToolResultErrorBlock { error_code, type }
type: :web_fetch_tool_result_error
class BetaWebFetchBlock { content, retrieved_at, type, url }
Citation configuration for the document
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type }
class BetaBase64PDFSource { data, media_type, type }
media_type: :"application/pdf"
type: :base64
class BetaPlainTextSource { data, media_type, type }
media_type: :"text/plain"
type: :text
title: String
The title of the document
type: :document
retrieved_at: String
ISO 8601 timestamp when the content was retrieved
type: :web_fetch_result
url: String
Fetched content URL
type: :web_fetch_tool_result
class BetaCodeExecutionToolResultBlock { content, tool_use_id, type }
class BetaCodeExecutionToolResultError { error_code, type }
type: :code_execution_tool_result_error
class BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }
type: :code_execution_output
type: :code_execution_result
type: :code_execution_tool_result
class BetaBashCodeExecutionToolResultBlock { content, tool_use_id, type }
content: BetaBashCodeExecutionToolResultError { error_code, type } | BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
class BetaBashCodeExecutionToolResultError { error_code, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :bash_code_execution_tool_result_error
class BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
type: :bash_code_execution_output
type: :bash_code_execution_result
type: :bash_code_execution_tool_result
class BetaTextEditorCodeExecutionToolResultBlock { content, tool_use_id, type }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } | BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } | BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } | BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
class BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :text_editor_code_execution_tool_result_error
class BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more }
file_type: :text | :image | :pdf
type: :text_editor_code_execution_view_result
class BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type }
type: :text_editor_code_execution_create_result
class BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
type: :text_editor_code_execution_str_replace_result
type: :text_editor_code_execution_tool_result
class BetaToolSearchToolResultBlock { content, tool_use_id, type }
content: BetaToolSearchToolResultError { error_code, error_message, type } | BetaToolSearchToolSearchResultBlock { tool_references, type }
class BetaToolSearchToolResultError { error_code, error_message, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | :execution_time_exceeded
type: :tool_search_tool_result_error
class BetaToolSearchToolSearchResultBlock { tool_references, type }
type: :tool_reference
type: :tool_search_tool_search_result
type: :tool_search_tool_result
class BetaMCPToolUseBlock { id, input, name, 2 more }
name: String
The name of the MCP tool
server_name: String
The name of the MCP server
type: :mcp_tool_use
class BetaMCPToolResultBlock { content, is_error, tool_use_id, type }
Array[BetaTextBlock { citations, text, type } ]
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: :char_location
class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: :page_location
class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: :content_block_location
class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :text
type: :mcp_tool_result
class BetaContainerUploadBlock { file_id, type }
Response model for a file uploaded to the container.
type: :container_upload
Context management response.
Information about context management strategies applied during the request.
applied_edits: Array[BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } | BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type } ]
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type }
cleared_input_tokens: Integer
Number of input tokens cleared by this edit.
cleared_tool_uses: Integer
Number of tool uses that were cleared.
type: :clear_tool_uses_20250919
The type of context management edit applied.
class BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }
cleared_input_tokens: Integer
Number of input tokens cleared by this edit.
cleared_thinking_turns: Integer
Number of thinking turns that were cleared.
type: :clear_thinking_20251015
The type of context management edit applied.
The model that will complete your prompt.
See models for additional details and options.
:"claude-opus-4-5-20251101" | :"claude-opus-4-5" | :"claude-3-7-sonnet-latest" | 17 more
The model that will complete your prompt.
See models for additional details and options.
:"claude-opus-4-5-20251101"
Premium model combining maximum intelligence with practical performance
:"claude-opus-4-5"
Premium model combining maximum intelligence with practical performance
:"claude-3-7-sonnet-latest"
High-performance model with early extended thinking
:"claude-3-7-sonnet-20250219"
High-performance model with early extended thinking
:"claude-3-5-haiku-latest"
Fastest and most compact model for near-instant responsiveness
:"claude-3-5-haiku-20241022"
Our fastest model
:"claude-haiku-4-5"
Hybrid model, capable of near-instant responses and extended thinking
:"claude-haiku-4-5-20251001"
Hybrid model, capable of near-instant responses and extended thinking
:"claude-sonnet-4-20250514"
High-performance model with extended thinking
:"claude-sonnet-4-0"
High-performance model with extended thinking
:"claude-4-sonnet-20250514"
High-performance model with extended thinking
:"claude-sonnet-4-5"
Our best model for real-world agents and coding
:"claude-sonnet-4-5-20250929"
Our best model for real-world agents and coding
:"claude-opus-4-0"
Our most capable model
:"claude-opus-4-20250514"
Our most capable model
:"claude-4-opus-20250514"
Our most capable model
:"claude-opus-4-1-20250805"
Our most capable model
:"claude-3-opus-latest"
Excels at writing and complex tasks
:"claude-3-opus-20240229"
Excels at writing and complex tasks
:"claude-3-haiku-20240307"
Our previous most fast and cost-effective
role: :assistant
Conversational role of the generated message.
This will always be "assistant".
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
stop_sequence: String
Which custom stop sequence was generated, if any.
This value will be a non-null string if one of your custom stop sequences was generated.
type: :message
Object type.
For Messages, this is always "message".
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
Breakdown of cached tokens by TTL
ephemeral_1h_input_tokens: Integer
The number of input tokens used to create the 1 hour cache entry.
ephemeral_5m_input_tokens: Integer
The number of input tokens used to create the 5 minute cache entry.
cache_creation_input_tokens: Integer
The number of input tokens used to create the cache entry.
cache_read_input_tokens: Integer
The number of input tokens read from the cache.
input_tokens: Integer
The number of input tokens which were used.
output_tokens: Integer
The number of output tokens which were used.
The number of server tool requests.
web_fetch_requests: Integer
The number of web fetch tool requests.
web_search_requests: Integer
The number of web search tool requests.
service_tier: :standard | :priority | :batch
If the request used the priority, standard, or batch tier.
type: :message_start
class BetaRawMessageStopEvent { type }
type: :message_stop
BetaRawMessageStreamEvent = BetaRawMessageStartEvent { message, type } | BetaRawMessageDeltaEvent { context_management, delta, type, usage } | BetaRawMessageStopEvent { type } | 3 more
class BetaRawMessageStartEvent { message, type }
id: String
Unique object identifier.
The format and length of IDs may change over time.
Information about the container used in the request (for the code execution tool)
id: String
Identifier for the container used in this request
expires_at: Time
The time at which the container will expire.
Skills loaded in the container
skill_id: String
Skill ID
type: :anthropic | :custom
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
version: String
Skill version or 'latest' for most recent version
Content generated by the model.
This is an array of content blocks, each of which has a type that determines its shape.
Example:
[{"type": "text", "text": "Hi, I'm Claude."}]
If the request input messages ended with an assistant turn, then the response content will continue directly from that last turn. You can use this to constrain the model's output.
For example, if the input messages were:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("}
]
Then the response content might be:
[{"type": "text", "text": "B)"}]
class BetaTextBlock { citations, text, type }
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: :char_location
class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: :page_location
class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: :content_block_location
class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :text
class BetaThinkingBlock { signature, thinking, type }
type: :thinking
class BetaRedactedThinkingBlock { data, type }
type: :redacted_thinking
class BetaToolUseBlock { id, input, name, 2 more }
type: :tool_use
Tool invocation directly from the model.
class BetaDirectCaller { type }
Tool invocation directly from the model.
type: :direct
class BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: :code_execution_20250825
class BetaServerToolUseBlock { id, caller_, input, 2 more }
Tool invocation directly from the model.
class BetaDirectCaller { type }
Tool invocation directly from the model.
type: :direct
class BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: :code_execution_20250825
name: :web_search | :web_fetch | :code_execution | 4 more
type: :server_tool_use
class BetaWebSearchToolResultBlock { content, tool_use_id, type }
class BetaWebSearchToolResultError { error_code, type }
type: :web_search_tool_result_error
Array[BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more } ]
type: :web_search_result
type: :web_search_tool_result
class BetaWebFetchToolResultBlock { content, tool_use_id, type }
content: BetaWebFetchToolResultErrorBlock { error_code, type } | BetaWebFetchBlock { content, retrieved_at, type, url }
class BetaWebFetchToolResultErrorBlock { error_code, type }
type: :web_fetch_tool_result_error
class BetaWebFetchBlock { content, retrieved_at, type, url }
Citation configuration for the document
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type }
class BetaBase64PDFSource { data, media_type, type }
media_type: :"application/pdf"
type: :base64
class BetaPlainTextSource { data, media_type, type }
media_type: :"text/plain"
type: :text
title: String
The title of the document
type: :document
retrieved_at: String
ISO 8601 timestamp when the content was retrieved
type: :web_fetch_result
url: String
Fetched content URL
type: :web_fetch_tool_result
class BetaCodeExecutionToolResultBlock { content, tool_use_id, type }
class BetaCodeExecutionToolResultError { error_code, type }
type: :code_execution_tool_result_error
class BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }
type: :code_execution_output
type: :code_execution_result
type: :code_execution_tool_result
class BetaBashCodeExecutionToolResultBlock { content, tool_use_id, type }
content: BetaBashCodeExecutionToolResultError { error_code, type } | BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
class BetaBashCodeExecutionToolResultError { error_code, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :bash_code_execution_tool_result_error
class BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
type: :bash_code_execution_output
type: :bash_code_execution_result
type: :bash_code_execution_tool_result
class BetaTextEditorCodeExecutionToolResultBlock { content, tool_use_id, type }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } | BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } | BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } | BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
class BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :text_editor_code_execution_tool_result_error
class BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more }
file_type: :text | :image | :pdf
type: :text_editor_code_execution_view_result
class BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type }
type: :text_editor_code_execution_create_result
class BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
type: :text_editor_code_execution_str_replace_result
type: :text_editor_code_execution_tool_result
class BetaToolSearchToolResultBlock { content, tool_use_id, type }
content: BetaToolSearchToolResultError { error_code, error_message, type } | BetaToolSearchToolSearchResultBlock { tool_references, type }
class BetaToolSearchToolResultError { error_code, error_message, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | :execution_time_exceeded
type: :tool_search_tool_result_error
class BetaToolSearchToolSearchResultBlock { tool_references, type }
type: :tool_reference
type: :tool_search_tool_search_result
type: :tool_search_tool_result
class BetaMCPToolUseBlock { id, input, name, 2 more }
name: String
The name of the MCP tool
server_name: String
The name of the MCP server
type: :mcp_tool_use
class BetaMCPToolResultBlock { content, is_error, tool_use_id, type }
Array[BetaTextBlock { citations, text, type } ]
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: :char_location
class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: :page_location
class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: :content_block_location
class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :text
type: :mcp_tool_result
class BetaContainerUploadBlock { file_id, type }
Response model for a file uploaded to the container.
type: :container_upload
Context management response.
Information about context management strategies applied during the request.
applied_edits: Array[BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } | BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type } ]
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type }
cleared_input_tokens: Integer
Number of input tokens cleared by this edit.
cleared_tool_uses: Integer
Number of tool uses that were cleared.
type: :clear_tool_uses_20250919
The type of context management edit applied.
class BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }
cleared_input_tokens: Integer
Number of input tokens cleared by this edit.
cleared_thinking_turns: Integer
Number of thinking turns that were cleared.
type: :clear_thinking_20251015
The type of context management edit applied.
The model that will complete your prompt.
See models for additional details and options.
:"claude-opus-4-5-20251101" | :"claude-opus-4-5" | :"claude-3-7-sonnet-latest" | 17 more
The model that will complete your prompt.
See models for additional details and options.
:"claude-opus-4-5-20251101"
Premium model combining maximum intelligence with practical performance
:"claude-opus-4-5"
Premium model combining maximum intelligence with practical performance
:"claude-3-7-sonnet-latest"
High-performance model with early extended thinking
:"claude-3-7-sonnet-20250219"
High-performance model with early extended thinking
:"claude-3-5-haiku-latest"
Fastest and most compact model for near-instant responsiveness
:"claude-3-5-haiku-20241022"
Our fastest model
:"claude-haiku-4-5"
Hybrid model, capable of near-instant responses and extended thinking
:"claude-haiku-4-5-20251001"
Hybrid model, capable of near-instant responses and extended thinking
:"claude-sonnet-4-20250514"
High-performance model with extended thinking
:"claude-sonnet-4-0"
High-performance model with extended thinking
:"claude-4-sonnet-20250514"
High-performance model with extended thinking
:"claude-sonnet-4-5"
Our best model for real-world agents and coding
:"claude-sonnet-4-5-20250929"
Our best model for real-world agents and coding
:"claude-opus-4-0"
Our most capable model
:"claude-opus-4-20250514"
Our most capable model
:"claude-4-opus-20250514"
Our most capable model
:"claude-opus-4-1-20250805"
Our most capable model
:"claude-3-opus-latest"
Excels at writing and complex tasks
:"claude-3-opus-20240229"
Excels at writing and complex tasks
:"claude-3-haiku-20240307"
Our previous most fast and cost-effective
role: :assistant
Conversational role of the generated message.
This will always be "assistant".
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
stop_sequence: String
Which custom stop sequence was generated, if any.
This value will be a non-null string if one of your custom stop sequences was generated.
type: :message
Object type.
For Messages, this is always "message".
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
Breakdown of cached tokens by TTL
ephemeral_1h_input_tokens: Integer
The number of input tokens used to create the 1 hour cache entry.
ephemeral_5m_input_tokens: Integer
The number of input tokens used to create the 5 minute cache entry.
cache_creation_input_tokens: Integer
The number of input tokens used to create the cache entry.
cache_read_input_tokens: Integer
The number of input tokens read from the cache.
input_tokens: Integer
The number of input tokens which were used.
output_tokens: Integer
The number of output tokens which were used.
The number of server tool requests.
web_fetch_requests: Integer
The number of web fetch tool requests.
web_search_requests: Integer
The number of web search tool requests.
service_tier: :standard | :priority | :batch
If the request used the priority, standard, or batch tier.
type: :message_start
class BetaRawMessageDeltaEvent { context_management, delta, type, usage }
Information about context management strategies applied during the request
applied_edits: Array[BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } | BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type } ]
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type }
cleared_input_tokens: Integer
Number of input tokens cleared by this edit.
cleared_tool_uses: Integer
Number of tool uses that were cleared.
type: :clear_tool_uses_20250919
The type of context management edit applied.
class BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }
cleared_input_tokens: Integer
Number of input tokens cleared by this edit.
cleared_thinking_turns: Integer
Number of thinking turns that were cleared.
type: :clear_thinking_20251015
The type of context management edit applied.
delta: { container, stop_reason, stop_sequence}
Information about the container used in the request (for the code execution tool)
id: String
Identifier for the container used in this request
expires_at: Time
The time at which the container will expire.
Skills loaded in the container
skill_id: String
Skill ID
type: :anthropic | :custom
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
version: String
Skill version or 'latest' for most recent version
type: :message_delta
usage: BetaMessageDeltaUsage { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more }
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: Integer
The cumulative number of input tokens used to create the cache entry.
cache_read_input_tokens: Integer
The cumulative number of input tokens read from the cache.
input_tokens: Integer
The cumulative number of input tokens which were used.
output_tokens: Integer
The cumulative number of output tokens which were used.
The number of server tool requests.
web_fetch_requests: Integer
The number of web fetch tool requests.
web_search_requests: Integer
The number of web search tool requests.
class BetaRawMessageStopEvent { type }
type: :message_stop
class BetaRawContentBlockStartEvent { content_block, index, type }
content_block: BetaTextBlock { citations, text, type } | BetaThinkingBlock { signature, thinking, type } | BetaRedactedThinkingBlock { data, type } | 11 more
Response model for a file uploaded to the container.
class BetaTextBlock { citations, text, type }
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: :char_location
class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: :page_location
class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: :content_block_location
class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :text
class BetaThinkingBlock { signature, thinking, type }
type: :thinking
class BetaRedactedThinkingBlock { data, type }
type: :redacted_thinking
class BetaToolUseBlock { id, input, name, 2 more }
type: :tool_use
Tool invocation directly from the model.
class BetaDirectCaller { type }
Tool invocation directly from the model.
type: :direct
class BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: :code_execution_20250825
class BetaServerToolUseBlock { id, caller_, input, 2 more }
Tool invocation directly from the model.
class BetaDirectCaller { type }
Tool invocation directly from the model.
type: :direct
class BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: :code_execution_20250825
name: :web_search | :web_fetch | :code_execution | 4 more
type: :server_tool_use
class BetaWebSearchToolResultBlock { content, tool_use_id, type }
class BetaWebSearchToolResultError { error_code, type }
type: :web_search_tool_result_error
Array[BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more } ]
type: :web_search_result
type: :web_search_tool_result
class BetaWebFetchToolResultBlock { content, tool_use_id, type }
content: BetaWebFetchToolResultErrorBlock { error_code, type } | BetaWebFetchBlock { content, retrieved_at, type, url }
class BetaWebFetchToolResultErrorBlock { error_code, type }
type: :web_fetch_tool_result_error
class BetaWebFetchBlock { content, retrieved_at, type, url }
Citation configuration for the document
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type }
class BetaBase64PDFSource { data, media_type, type }
media_type: :"application/pdf"
type: :base64
class BetaPlainTextSource { data, media_type, type }
media_type: :"text/plain"
type: :text
title: String
The title of the document
type: :document
retrieved_at: String
ISO 8601 timestamp when the content was retrieved
type: :web_fetch_result
url: String
Fetched content URL
type: :web_fetch_tool_result
class BetaCodeExecutionToolResultBlock { content, tool_use_id, type }
class BetaCodeExecutionToolResultError { error_code, type }
type: :code_execution_tool_result_error
class BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }
type: :code_execution_output
type: :code_execution_result
type: :code_execution_tool_result
class BetaBashCodeExecutionToolResultBlock { content, tool_use_id, type }
content: BetaBashCodeExecutionToolResultError { error_code, type } | BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
class BetaBashCodeExecutionToolResultError { error_code, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :bash_code_execution_tool_result_error
class BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
type: :bash_code_execution_output
type: :bash_code_execution_result
type: :bash_code_execution_tool_result
class BetaTextEditorCodeExecutionToolResultBlock { content, tool_use_id, type }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } | BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } | BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } | BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
class BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :text_editor_code_execution_tool_result_error
class BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more }
file_type: :text | :image | :pdf
type: :text_editor_code_execution_view_result
class BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type }
type: :text_editor_code_execution_create_result
class BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
type: :text_editor_code_execution_str_replace_result
type: :text_editor_code_execution_tool_result
class BetaToolSearchToolResultBlock { content, tool_use_id, type }
content: BetaToolSearchToolResultError { error_code, error_message, type } | BetaToolSearchToolSearchResultBlock { tool_references, type }
class BetaToolSearchToolResultError { error_code, error_message, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | :execution_time_exceeded
type: :tool_search_tool_result_error
class BetaToolSearchToolSearchResultBlock { tool_references, type }
type: :tool_reference
type: :tool_search_tool_search_result
type: :tool_search_tool_result
class BetaMCPToolUseBlock { id, input, name, 2 more }
name: String
The name of the MCP tool
server_name: String
The name of the MCP server
type: :mcp_tool_use
class BetaMCPToolResultBlock { content, is_error, tool_use_id, type }
Array[BetaTextBlock { citations, text, type } ]
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: :char_location
class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: :page_location
class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: :content_block_location
class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :text
type: :mcp_tool_result
class BetaContainerUploadBlock { file_id, type }
Response model for a file uploaded to the container.
type: :container_upload
type: :content_block_start
class BetaRawContentBlockDeltaEvent { delta, index, type }
class BetaTextDelta { text, type }
type: :text_delta
class BetaInputJSONDelta { partial_json, type }
type: :input_json_delta
class BetaCitationsDelta { citation, type }
citation: BetaCitationCharLocation { cited_text, document_index, document_title, 4 more } | BetaCitationPageLocation { cited_text, document_index, document_title, 4 more } | BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more } | 2 more
class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: :char_location
class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: :page_location
class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: :content_block_location
class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :citations_delta
class BetaThinkingDelta { thinking, type }
type: :thinking_delta
class BetaSignatureDelta { signature, type }
type: :signature_delta
type: :content_block_delta
class BetaRawContentBlockStopEvent { index, type }
type: :content_block_stop
class BetaRedactedThinkingBlock { data, type }
type: :redacted_thinking
class BetaRedactedThinkingBlockParam { data, type }
type: :redacted_thinking
class BetaRequestDocumentBlock { source, type, cache_control, 3 more }
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type } | BetaContentBlockSource { content, type } | 2 more
class BetaBase64PDFSource { data, media_type, type }
media_type: :"application/pdf"
type: :base64
class BetaPlainTextSource { data, media_type, type }
media_type: :"text/plain"
type: :text
class BetaContentBlockSource { content, type }
class BetaTextBlockParam { text, type, cache_control, citations }
type: :text
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
class BetaBase64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
type: :base64
class BetaURLImageSource { type, url }
type: :url
class BetaFileImageSource { file_id, type }
type: :file
type: :image
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: :content
class BetaURLPDFSource { type, url }
type: :url
class BetaFileDocumentSource { file_id, type }
type: :file
type: :document
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaRequestMCPServerToolConfiguration { allowed_tools, enabled }
class BetaRequestMCPServerURLDefinition { name, type, url, 2 more }
type: :url
class BetaRequestMCPToolResultBlockParam { tool_use_id, type, cache_control, 2 more }
type: :mcp_tool_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Array[BetaTextBlockParam { text, type, cache_control, citations } ]
type: :text
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaSearchResultBlockParam { content, source, title, 3 more }
type: :text
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :search_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: :code_execution_20250825
class BetaServerToolUsage { web_fetch_requests, web_search_requests }
web_fetch_requests: Integer
The number of web fetch tool requests.
web_search_requests: Integer
The number of web search tool requests.
class BetaServerToolUseBlock { id, caller_, input, 2 more }
Tool invocation directly from the model.
class BetaDirectCaller { type }
Tool invocation directly from the model.
type: :direct
class BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: :code_execution_20250825
name: :web_search | :web_fetch | :code_execution | 4 more
type: :server_tool_use
class BetaServerToolUseBlockParam { id, input, name, 3 more }
name: :web_search | :web_fetch | :code_execution | 4 more
type: :server_tool_use
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Tool invocation directly from the model.
class BetaDirectCaller { type }
Tool invocation directly from the model.
type: :direct
class BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: :code_execution_20250825
class BetaSignatureDelta { signature, type }
type: :signature_delta
class BetaSkill { skill_id, type, version }
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)
version: String
Skill version or 'latest' for most recent version
class BetaSkillParams { skill_id, type, version }
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)
version: String
Skill version or 'latest' for most recent version
BetaStopReason = :end_turn | :max_tokens | :stop_sequence | 4 more
class BetaTextBlock { citations, text, type }
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: :char_location
class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: :page_location
class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: :content_block_location
class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :text
class BetaTextBlockParam { text, type, cache_control, citations }
type: :text
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
BetaTextCitation = BetaCitationCharLocation { cited_text, document_index, document_title, 4 more } | BetaCitationPageLocation { cited_text, document_index, document_title, 4 more } | BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more } | 2 more
class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: :char_location
class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: :page_location
class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: :content_block_location
class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
BetaTextCitationParam = BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more } | BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more } | BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more } | 2 more
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaTextDelta { text, type }
type: :text_delta
class BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type }
type: :text_editor_code_execution_create_result
class BetaTextEditorCodeExecutionCreateResultBlockParam { is_file_update, type }
type: :text_editor_code_execution_create_result
class BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
type: :text_editor_code_execution_str_replace_result
class BetaTextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }
type: :text_editor_code_execution_str_replace_result
class BetaTextEditorCodeExecutionToolResultBlock { content, tool_use_id, type }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } | BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } | BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } | BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
class BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :text_editor_code_execution_tool_result_error
class BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more }
file_type: :text | :image | :pdf
type: :text_editor_code_execution_view_result
class BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type }
type: :text_editor_code_execution_create_result
class BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
type: :text_editor_code_execution_str_replace_result
type: :text_editor_code_execution_tool_result
class BetaTextEditorCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }
content: BetaTextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message } | BetaTextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more } | BetaTextEditorCodeExecutionCreateResultBlockParam { is_file_update, type } | BetaTextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }
class BetaTextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :text_editor_code_execution_tool_result_error
class BetaTextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more }
file_type: :text | :image | :pdf
type: :text_editor_code_execution_view_result
class BetaTextEditorCodeExecutionCreateResultBlockParam { is_file_update, type }
type: :text_editor_code_execution_create_result
class BetaTextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }
type: :text_editor_code_execution_str_replace_result
type: :text_editor_code_execution_tool_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :text_editor_code_execution_tool_result_error
class BetaTextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :text_editor_code_execution_tool_result_error
class BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more }
file_type: :text | :image | :pdf
type: :text_editor_code_execution_view_result
class BetaTextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more }
file_type: :text | :image | :pdf
type: :text_editor_code_execution_view_result
class BetaThinkingBlock { signature, thinking, type }
type: :thinking
class BetaThinkingBlockParam { signature, thinking, type }
type: :thinking
class BetaThinkingConfigDisabled { type }
type: :disabled
class BetaThinkingConfigEnabled { budget_tokens, type }
budget_tokens: Integer
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 for details.
type: :enabled
BetaThinkingConfigParam = BetaThinkingConfigEnabled { budget_tokens, type } | BetaThinkingConfigDisabled { type }
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 for details.
class BetaThinkingConfigEnabled { budget_tokens, type }
budget_tokens: Integer
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 for details.
type: :enabled
class BetaThinkingConfigDisabled { type }
type: :disabled
class BetaThinkingDelta { thinking, type }
type: :thinking_delta
class BetaThinkingTurns { type, value }
type: :thinking_turns
class BetaTool { input_schema, name, allowed_callers, 6 more }
input_schema: { type, properties, required}
JSON schema for this tool's input.
This defines the shape of the input that your tool accepts and that the model will produce.
type: :object
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]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
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.
type: :custom
class BetaToolBash20241022 { name, type, allowed_callers, 4 more }
name: :bash
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: :bash_20241022
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolBash20250124 { name, type, allowed_callers, 4 more }
name: :bash
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: :bash_20250124
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
BetaToolChoice = BetaToolChoiceAuto { type, disable_parallel_tool_use } | BetaToolChoiceAny { type, disable_parallel_tool_use } | BetaToolChoiceTool { name, type, disable_parallel_tool_use } | BetaToolChoiceNone { type }
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.
class BetaToolChoiceAuto { type, disable_parallel_tool_use }
The model will automatically decide whether to use tools.
type: :auto
disable_parallel_tool_use: bool
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output at most one tool use.
class BetaToolChoiceAny { type, disable_parallel_tool_use }
The model will use any available tools.
type: :any
disable_parallel_tool_use: bool
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
class BetaToolChoiceTool { name, type, disable_parallel_tool_use }
The model will use the specified tool with tool_choice.name.
name: String
The name of the tool to use.
type: :tool
disable_parallel_tool_use: bool
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
class BetaToolChoiceNone { type }
The model will not be allowed to use tools.
type: :none
class BetaToolChoiceAny { type, disable_parallel_tool_use }
The model will use any available tools.
type: :any
disable_parallel_tool_use: bool
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
class BetaToolChoiceAuto { type, disable_parallel_tool_use }
The model will automatically decide whether to use tools.
type: :auto
disable_parallel_tool_use: bool
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output at most one tool use.
class BetaToolChoiceNone { type }
The model will not be allowed to use tools.
type: :none
class BetaToolChoiceTool { name, type, disable_parallel_tool_use }
The model will use the specified tool with tool_choice.name.
name: String
The name of the tool to use.
type: :tool
disable_parallel_tool_use: bool
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
class BetaToolComputerUse20241022 { display_height_px, display_width_px, name, 7 more }
display_height_px: Integer
The height of the display in pixels.
display_width_px: Integer
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.
type: :computer_20241022
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
display_number: Integer
The X11 display number (e.g. 0, 1) for the display.
class BetaToolComputerUse20250124 { display_height_px, display_width_px, name, 7 more }
display_height_px: Integer
The height of the display in pixels.
display_width_px: Integer
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.
type: :computer_20250124
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
display_number: Integer
The X11 display number (e.g. 0, 1) for the display.
class BetaToolComputerUse20251124 { display_height_px, display_width_px, name, 8 more }
display_height_px: Integer
The height of the display in pixels.
display_width_px: Integer
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.
type: :computer_20251124
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
display_number: Integer
The X11 display number (e.g. 0, 1) for the display.
enable_zoom: bool
Whether to enable an action to take a zoomed-in screenshot of the screen.
class BetaToolReferenceBlock { tool_name, type }
type: :tool_reference
class BetaToolReferenceBlockParam { tool_name, type, cache_control }
Tool reference block that can be included in tool_result content.
type: :tool_reference
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaToolResultBlockParam { tool_use_id, type, cache_control, 2 more }
type: :tool_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
content: String | Array[BetaTextBlockParam { text, type, cache_control, citations } | BetaImageBlockParam { source, type, cache_control } | BetaSearchResultBlockParam { content, source, title, 3 more } | 2 more]
Array[BetaTextBlockParam { text, type, cache_control, citations } | BetaImageBlockParam { source, type, cache_control } | BetaSearchResultBlockParam { content, source, title, 3 more } | 2 more]
class BetaTextBlockParam { text, type, cache_control, citations }
type: :text
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
class BetaBase64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
type: :base64
class BetaURLImageSource { type, url }
type: :url
class BetaFileImageSource { file_id, type }
type: :file
type: :image
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaSearchResultBlockParam { content, source, title, 3 more }
type: :text
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :search_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaRequestDocumentBlock { source, type, cache_control, 3 more }
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type } | BetaContentBlockSource { content, type } | 2 more
class BetaBase64PDFSource { data, media_type, type }
media_type: :"application/pdf"
type: :base64
class BetaPlainTextSource { data, media_type, type }
media_type: :"text/plain"
type: :text
class BetaContentBlockSource { content, type }
class BetaTextBlockParam { text, type, cache_control, citations }
type: :text
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
class BetaBase64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
type: :base64
class BetaURLImageSource { type, url }
type: :url
class BetaFileImageSource { file_id, type }
type: :file
type: :image
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: :content
class BetaURLPDFSource { type, url }
type: :url
class BetaFileDocumentSource { file_id, type }
type: :file
type: :document
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaToolReferenceBlockParam { tool_name, type, cache_control }
Tool reference block that can be included in tool_result content.
type: :tool_reference
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaToolSearchToolBm25_20251119 { name, type, allowed_callers, 3 more }
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.
type: :tool_search_tool_bm25_20251119 | :tool_search_tool_bm25
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolSearchToolRegex20251119 { name, type, allowed_callers, 3 more }
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.
type: :tool_search_tool_regex_20251119 | :tool_search_tool_regex
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolSearchToolResultBlock { content, tool_use_id, type }
content: BetaToolSearchToolResultError { error_code, error_message, type } | BetaToolSearchToolSearchResultBlock { tool_references, type }
class BetaToolSearchToolResultError { error_code, error_message, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | :execution_time_exceeded
type: :tool_search_tool_result_error
class BetaToolSearchToolSearchResultBlock { tool_references, type }
type: :tool_reference
type: :tool_search_tool_search_result
type: :tool_search_tool_result
class BetaToolSearchToolResultBlockParam { content, tool_use_id, type, cache_control }
content: BetaToolSearchToolResultErrorParam { error_code, type } | BetaToolSearchToolSearchResultBlockParam { tool_references, type }
class BetaToolSearchToolResultErrorParam { error_code, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | :execution_time_exceeded
type: :tool_search_tool_result_error
class BetaToolSearchToolSearchResultBlockParam { tool_references, type }
type: :tool_reference
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: :tool_search_tool_search_result
type: :tool_search_tool_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaToolSearchToolResultError { error_code, error_message, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | :execution_time_exceeded
type: :tool_search_tool_result_error
class BetaToolSearchToolResultErrorParam { error_code, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | :execution_time_exceeded
type: :tool_search_tool_result_error
class BetaToolSearchToolSearchResultBlock { tool_references, type }
type: :tool_reference
type: :tool_search_tool_search_result
class BetaToolSearchToolSearchResultBlockParam { tool_references, type }
type: :tool_reference
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: :tool_search_tool_search_result
class BetaToolTextEditor20241022 { name, type, allowed_callers, 4 more }
name: :str_replace_editor
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: :text_editor_20241022
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolTextEditor20250124 { name, type, allowed_callers, 4 more }
name: :str_replace_editor
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: :text_editor_20250124
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolTextEditor20250429 { name, type, allowed_callers, 4 more }
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.
type: :text_editor_20250429
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolTextEditor20250728 { name, type, allowed_callers, 5 more }
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.
type: :text_editor_20250728
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
max_characters: Integer
Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.
BetaToolUnion = BetaTool { input_schema, name, allowed_callers, 6 more } | BetaToolBash20241022 { name, type, allowed_callers, 4 more } | BetaToolBash20250124 { name, type, allowed_callers, 4 more } | 15 more
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.
class BetaTool { input_schema, name, allowed_callers, 6 more }
input_schema: { type, properties, required}
JSON schema for this tool's input.
This defines the shape of the input that your tool accepts and that the model will produce.
type: :object
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]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
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.
type: :custom
class BetaToolBash20241022 { name, type, allowed_callers, 4 more }
name: :bash
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: :bash_20241022
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolBash20250124 { name, type, allowed_callers, 4 more }
name: :bash
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: :bash_20250124
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaCodeExecutionTool20250522 { name, type, allowed_callers, 3 more }
name: :code_execution
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: :code_execution_20250522
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaCodeExecutionTool20250825 { name, type, allowed_callers, 3 more }
name: :code_execution
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: :code_execution_20250825
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolComputerUse20241022 { display_height_px, display_width_px, name, 7 more }
display_height_px: Integer
The height of the display in pixels.
display_width_px: Integer
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.
type: :computer_20241022
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
display_number: Integer
The X11 display number (e.g. 0, 1) for the display.
class BetaMemoryTool20250818 { name, type, allowed_callers, 4 more }
name: :memory
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: :memory_20250818
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolComputerUse20250124 { display_height_px, display_width_px, name, 7 more }
display_height_px: Integer
The height of the display in pixels.
display_width_px: Integer
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.
type: :computer_20250124
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
display_number: Integer
The X11 display number (e.g. 0, 1) for the display.
class BetaToolTextEditor20241022 { name, type, allowed_callers, 4 more }
name: :str_replace_editor
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: :text_editor_20241022
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolComputerUse20251124 { display_height_px, display_width_px, name, 8 more }
display_height_px: Integer
The height of the display in pixels.
display_width_px: Integer
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.
type: :computer_20251124
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
display_number: Integer
The X11 display number (e.g. 0, 1) for the display.
enable_zoom: bool
Whether to enable an action to take a zoomed-in screenshot of the screen.
class BetaToolTextEditor20250124 { name, type, allowed_callers, 4 more }
name: :str_replace_editor
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: :text_editor_20250124
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolTextEditor20250429 { name, type, allowed_callers, 4 more }
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.
type: :text_editor_20250429
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolTextEditor20250728 { name, type, allowed_callers, 5 more }
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.
type: :text_editor_20250728
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
max_characters: Integer
Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.
class BetaWebSearchTool20250305 { name, type, allowed_callers, 7 more }
name: :web_search
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: :web_search_20250305
allowed_callers: Array[:direct | :code_execution_20250825]
allowed_domains: Array[String]
If provided, only these domains will be included in results. Cannot be used alongside blocked_domains.
blocked_domains: Array[String]
If provided, these domains will never appear in results. Cannot be used alongside allowed_domains.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
max_uses: Integer
Maximum number of times the tool can be used in the API request.
user_location: { type, city, country, 2 more}
Parameters for the user's location. Used to provide more relevant search results.
type: :approximate
city: String
The city of the user.
country: String
The two letter ISO country code of the user.
region: String
The region of the user.
timezone: String
The IANA timezone of the user.
class BetaWebFetchTool20250910 { name, type, allowed_callers, 8 more }
name: :web_fetch
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: :web_fetch_20250910
allowed_callers: Array[:direct | :code_execution_20250825]
allowed_domains: Array[String]
List of domains to allow fetching from
blocked_domains: Array[String]
List of domains to block fetching from
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Citations configuration for fetched documents. Citations are disabled by default.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
max_content_tokens: Integer
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: Integer
Maximum number of times the tool can be used in the API request.
class BetaToolSearchToolBm25_20251119 { name, type, allowed_callers, 3 more }
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.
type: :tool_search_tool_bm25_20251119 | :tool_search_tool_bm25
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolSearchToolRegex20251119 { name, type, allowed_callers, 3 more }
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.
type: :tool_search_tool_regex_20251119 | :tool_search_tool_regex
allowed_callers: Array[:direct | :code_execution_20250825]
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaMCPToolset { mcp_server_name, type, cache_control, 2 more }
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
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Configuration overrides for specific tools, keyed by tool name
Default configuration applied to all tools from this server
class BetaToolUseBlock { id, input, name, 2 more }
type: :tool_use
Tool invocation directly from the model.
class BetaDirectCaller { type }
Tool invocation directly from the model.
type: :direct
class BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: :code_execution_20250825
class BetaToolUseBlockParam { id, input, name, 3 more }
type: :tool_use
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Tool invocation directly from the model.
class BetaDirectCaller { type }
Tool invocation directly from the model.
type: :direct
class BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: :code_execution_20250825
class BetaToolUsesKeep { type, value }
type: :tool_uses
class BetaToolUsesTrigger { type, value }
type: :tool_uses
class BetaURLImageSource { type, url }
type: :url
class BetaURLPDFSource { type, url }
type: :url
class BetaUsage { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 more }
Breakdown of cached tokens by TTL
ephemeral_1h_input_tokens: Integer
The number of input tokens used to create the 1 hour cache entry.
ephemeral_5m_input_tokens: Integer
The number of input tokens used to create the 5 minute cache entry.
cache_creation_input_tokens: Integer
The number of input tokens used to create the cache entry.
cache_read_input_tokens: Integer
The number of input tokens read from the cache.
input_tokens: Integer
The number of input tokens which were used.
output_tokens: Integer
The number of output tokens which were used.
The number of server tool requests.
web_fetch_requests: Integer
The number of web fetch tool requests.
web_search_requests: Integer
The number of web search tool requests.
service_tier: :standard | :priority | :batch
If the request used the priority, standard, or batch tier.
class BetaWebFetchBlock { content, retrieved_at, type, url }
Citation configuration for the document
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type }
class BetaBase64PDFSource { data, media_type, type }
media_type: :"application/pdf"
type: :base64
class BetaPlainTextSource { data, media_type, type }
media_type: :"text/plain"
type: :text
title: String
The title of the document
type: :document
retrieved_at: String
ISO 8601 timestamp when the content was retrieved
type: :web_fetch_result
url: String
Fetched content URL
class BetaWebFetchBlockParam { content, type, url, retrieved_at }
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type } | BetaContentBlockSource { content, type } | 2 more
class BetaBase64PDFSource { data, media_type, type }
media_type: :"application/pdf"
type: :base64
class BetaPlainTextSource { data, media_type, type }
media_type: :"text/plain"
type: :text
class BetaContentBlockSource { content, type }
class BetaTextBlockParam { text, type, cache_control, citations }
type: :text
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
class BetaBase64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
type: :base64
class BetaURLImageSource { type, url }
type: :url
class BetaFileImageSource { file_id, type }
type: :file
type: :image
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: :content
class BetaURLPDFSource { type, url }
type: :url
class BetaFileDocumentSource { file_id, type }
type: :file
type: :document
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: :web_fetch_result
url: String
Fetched content URL
retrieved_at: String
ISO 8601 timestamp when the content was retrieved
class BetaWebFetchTool20250910 { name, type, allowed_callers, 8 more }
name: :web_fetch
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: :web_fetch_20250910
allowed_callers: Array[:direct | :code_execution_20250825]
allowed_domains: Array[String]
List of domains to allow fetching from
blocked_domains: Array[String]
List of domains to block fetching from
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Citations configuration for fetched documents. Citations are disabled by default.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
max_content_tokens: Integer
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: Integer
Maximum number of times the tool can be used in the API request.
class BetaWebFetchToolResultBlock { content, tool_use_id, type }
content: BetaWebFetchToolResultErrorBlock { error_code, type } | BetaWebFetchBlock { content, retrieved_at, type, url }
class BetaWebFetchToolResultErrorBlock { error_code, type }
type: :web_fetch_tool_result_error
class BetaWebFetchBlock { content, retrieved_at, type, url }
Citation configuration for the document
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type }
class BetaBase64PDFSource { data, media_type, type }
media_type: :"application/pdf"
type: :base64
class BetaPlainTextSource { data, media_type, type }
media_type: :"text/plain"
type: :text
title: String
The title of the document
type: :document
retrieved_at: String
ISO 8601 timestamp when the content was retrieved
type: :web_fetch_result
url: String
Fetched content URL
type: :web_fetch_tool_result
class BetaWebFetchToolResultBlockParam { content, tool_use_id, type, cache_control }
content: BetaWebFetchToolResultErrorBlockParam { error_code, type } | BetaWebFetchBlockParam { content, type, url, retrieved_at }
class BetaWebFetchToolResultErrorBlockParam { error_code, type }
type: :web_fetch_tool_result_error
class BetaWebFetchBlockParam { content, type, url, retrieved_at }
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type } | BetaContentBlockSource { content, type } | 2 more
class BetaBase64PDFSource { data, media_type, type }
media_type: :"application/pdf"
type: :base64
class BetaPlainTextSource { data, media_type, type }
media_type: :"text/plain"
type: :text
class BetaContentBlockSource { content, type }
class BetaTextBlockParam { text, type, cache_control, citations }
type: :text
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
class BetaBase64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
type: :base64
class BetaURLImageSource { type, url }
type: :url
class BetaFileImageSource { file_id, type }
type: :file
type: :image
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: :content
class BetaURLPDFSource { type, url }
type: :url
class BetaFileDocumentSource { file_id, type }
type: :file
type: :document
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: :web_fetch_result
url: String
Fetched content URL
retrieved_at: String
ISO 8601 timestamp when the content was retrieved
type: :web_fetch_tool_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaWebFetchToolResultErrorBlock { error_code, type }
type: :web_fetch_tool_result_error
class BetaWebFetchToolResultErrorBlockParam { error_code, type }
type: :web_fetch_tool_result_error
BetaWebFetchToolResultErrorCode = :invalid_tool_input | :url_too_long | :url_not_allowed | 5 more
class BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more }
type: :web_search_result
class BetaWebSearchResultBlockParam { encrypted_content, title, type, 2 more }
type: :web_search_result
class BetaWebSearchTool20250305 { name, type, allowed_callers, 7 more }
name: :web_search
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: :web_search_20250305
allowed_callers: Array[:direct | :code_execution_20250825]
allowed_domains: Array[String]
If provided, only these domains will be included in results. Cannot be used alongside blocked_domains.
blocked_domains: Array[String]
If provided, these domains will never appear in results. Cannot be used alongside allowed_domains.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading: bool
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
max_uses: Integer
Maximum number of times the tool can be used in the API request.
user_location: { type, city, country, 2 more}
Parameters for the user's location. Used to provide more relevant search results.
type: :approximate
city: String
The city of the user.
country: String
The two letter ISO country code of the user.
region: String
The region of the user.
timezone: String
The IANA timezone of the user.
class BetaWebSearchToolRequestError { error_code, type }
type: :web_search_tool_result_error
class BetaWebSearchToolResultBlock { content, tool_use_id, type }
class BetaWebSearchToolResultError { error_code, type }
type: :web_search_tool_result_error
Array[BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more } ]
type: :web_search_result
type: :web_search_tool_result
BetaWebSearchToolResultBlockContent = BetaWebSearchToolResultError { error_code, type } | Array[BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more } ]
class BetaWebSearchToolResultError { error_code, type }
type: :web_search_tool_result_error
Array[BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more } ]
type: :web_search_result
class BetaWebSearchToolResultBlockParam { content, tool_use_id, type, cache_control }
Array[BetaWebSearchResultBlockParam { encrypted_content, title, type, 2 more } ]
type: :web_search_result
class BetaWebSearchToolRequestError { error_code, type }
type: :web_search_tool_result_error
type: :web_search_tool_result
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaWebSearchToolResultBlockParamContent = Array[BetaWebSearchResultBlockParam { encrypted_content, title, type, 2 more } ] | BetaWebSearchToolRequestError { error_code, type }
Array[BetaWebSearchResultBlockParam { encrypted_content, title, type, 2 more } ]
type: :web_search_result
class BetaWebSearchToolRequestError { error_code, type }
type: :web_search_tool_result_error
class BetaWebSearchToolResultError { error_code, type }
type: :web_search_tool_result_error
BetaWebSearchToolResultErrorCode = :invalid_tool_input | :unavailable | :max_uses_exceeded | 2 more
BetaMessagesBatches
Create a Message Batch
Retrieve a Message Batch
List Message Batches
Cancel a Message Batch
Delete a Message Batch
Retrieve Message Batch results
ModelsExpand Collapse
class BetaDeletedMessageBatch { id, type }
id: String
ID of the Message Batch.
type: :message_batch_deleted
Deleted object type.
For Message Batches, this is always "message_batch_deleted".
class BetaMessageBatch { id, archived_at, cancel_initiated_at, 7 more }
id: String
Unique object identifier.
The format and length of IDs may change over time.
archived_at: Time
RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.
cancel_initiated_at: Time
RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated.
created_at: Time
RFC 3339 datetime string representing the time at which the Message Batch was created.
ended_at: Time
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: Time
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.
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: Integer
Number of requests in the Message Batch that have been canceled.
This is zero until processing of the entire Message Batch has ended.
errored: Integer
Number of requests in the Message Batch that encountered an error.
This is zero until processing of the entire Message Batch has ended.
expired: Integer
Number of requests in the Message Batch that have expired.
This is zero until processing of the entire Message Batch has ended.
processing: Integer
Number of requests in the Message Batch that are processing.
succeeded: Integer
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
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".
class BetaMessageBatchCanceledResult { type }
type: :canceled
class BetaMessageBatchErroredResult { error, type }
class BetaInvalidRequestError { message, type }
type: :invalid_request_error
class BetaAuthenticationError { message, type }
type: :authentication_error
class BetaBillingError { message, type }
type: :billing_error
class BetaPermissionError { message, type }
type: :permission_error
class BetaNotFoundError { message, type }
type: :not_found_error
class BetaRateLimitError { message, type }
type: :rate_limit_error
class BetaGatewayTimeoutError { message, type }
type: :timeout_error
class BetaAPIError { message, type }
type: :api_error
class BetaOverloadedError { message, type }
type: :overloaded_error
type: :error
type: :errored
class BetaMessageBatchExpiredResult { type }
type: :expired
class BetaMessageBatchIndividualResponse { custom_id, result }
This is a single line in the response .jsonl file and does not represent the response as a whole.
custom_id: String
Developer-provided ID created for each request in a Message Batch. Useful for matching results to requests, as results may be given out of request order.
Must be unique for each request within the Message Batch.
Processing result for this request.
Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration.
class BetaMessageBatchSucceededResult { message, type }
id: String
Unique object identifier.
The format and length of IDs may change over time.
Information about the container used in the request (for the code execution tool)
id: String
Identifier for the container used in this request
expires_at: Time
The time at which the container will expire.
Skills loaded in the container
skill_id: String
Skill ID
type: :anthropic | :custom
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
version: String
Skill version or 'latest' for most recent version
Content generated by the model.
This is an array of content blocks, each of which has a type that determines its shape.
Example:
[{"type": "text", "text": "Hi, I'm Claude."}]
If the request input messages ended with an assistant turn, then the response content will continue directly from that last turn. You can use this to constrain the model's output.
For example, if the input messages were:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("}
]
Then the response content might be:
[{"type": "text", "text": "B)"}]
class BetaTextBlock { citations, text, type }
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: :char_location
class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: :page_location
class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: :content_block_location
class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :text
class BetaThinkingBlock { signature, thinking, type }
type: :thinking
class BetaRedactedThinkingBlock { data, type }
type: :redacted_thinking
class BetaToolUseBlock { id, input, name, 2 more }
type: :tool_use
Tool invocation directly from the model.
class BetaDirectCaller { type }
Tool invocation directly from the model.
type: :direct
class BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: :code_execution_20250825
class BetaServerToolUseBlock { id, caller_, input, 2 more }
Tool invocation directly from the model.
class BetaDirectCaller { type }
Tool invocation directly from the model.
type: :direct
class BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: :code_execution_20250825
name: :web_search | :web_fetch | :code_execution | 4 more
type: :server_tool_use
class BetaWebSearchToolResultBlock { content, tool_use_id, type }
class BetaWebSearchToolResultError { error_code, type }
type: :web_search_tool_result_error
Array[BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more } ]
type: :web_search_result
type: :web_search_tool_result
class BetaWebFetchToolResultBlock { content, tool_use_id, type }
content: BetaWebFetchToolResultErrorBlock { error_code, type } | BetaWebFetchBlock { content, retrieved_at, type, url }
class BetaWebFetchToolResultErrorBlock { error_code, type }
type: :web_fetch_tool_result_error
class BetaWebFetchBlock { content, retrieved_at, type, url }
Citation configuration for the document
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type }
class BetaBase64PDFSource { data, media_type, type }
media_type: :"application/pdf"
type: :base64
class BetaPlainTextSource { data, media_type, type }
media_type: :"text/plain"
type: :text
title: String
The title of the document
type: :document
retrieved_at: String
ISO 8601 timestamp when the content was retrieved
type: :web_fetch_result
url: String
Fetched content URL
type: :web_fetch_tool_result
class BetaCodeExecutionToolResultBlock { content, tool_use_id, type }
class BetaCodeExecutionToolResultError { error_code, type }
type: :code_execution_tool_result_error
class BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }
type: :code_execution_output
type: :code_execution_result
type: :code_execution_tool_result
class BetaBashCodeExecutionToolResultBlock { content, tool_use_id, type }
content: BetaBashCodeExecutionToolResultError { error_code, type } | BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
class BetaBashCodeExecutionToolResultError { error_code, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :bash_code_execution_tool_result_error
class BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
type: :bash_code_execution_output
type: :bash_code_execution_result
type: :bash_code_execution_tool_result
class BetaTextEditorCodeExecutionToolResultBlock { content, tool_use_id, type }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } | BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } | BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } | BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
class BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :text_editor_code_execution_tool_result_error
class BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more }
file_type: :text | :image | :pdf
type: :text_editor_code_execution_view_result
class BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type }
type: :text_editor_code_execution_create_result
class BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
type: :text_editor_code_execution_str_replace_result
type: :text_editor_code_execution_tool_result
class BetaToolSearchToolResultBlock { content, tool_use_id, type }
content: BetaToolSearchToolResultError { error_code, error_message, type } | BetaToolSearchToolSearchResultBlock { tool_references, type }
class BetaToolSearchToolResultError { error_code, error_message, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | :execution_time_exceeded
type: :tool_search_tool_result_error
class BetaToolSearchToolSearchResultBlock { tool_references, type }
type: :tool_reference
type: :tool_search_tool_search_result
type: :tool_search_tool_result
class BetaMCPToolUseBlock { id, input, name, 2 more }
name: String
The name of the MCP tool
server_name: String
The name of the MCP server
type: :mcp_tool_use
class BetaMCPToolResultBlock { content, is_error, tool_use_id, type }
Array[BetaTextBlock { citations, text, type } ]
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: :char_location
class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: :page_location
class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: :content_block_location
class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :text
type: :mcp_tool_result
class BetaContainerUploadBlock { file_id, type }
Response model for a file uploaded to the container.
type: :container_upload
Context management response.
Information about context management strategies applied during the request.
applied_edits: Array[BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } | BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type } ]
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type }
cleared_input_tokens: Integer
Number of input tokens cleared by this edit.
cleared_tool_uses: Integer
Number of tool uses that were cleared.
type: :clear_tool_uses_20250919
The type of context management edit applied.
class BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }
cleared_input_tokens: Integer
Number of input tokens cleared by this edit.
cleared_thinking_turns: Integer
Number of thinking turns that were cleared.
type: :clear_thinking_20251015
The type of context management edit applied.
The model that will complete your prompt.
See models for additional details and options.
:"claude-opus-4-5-20251101" | :"claude-opus-4-5" | :"claude-3-7-sonnet-latest" | 17 more
The model that will complete your prompt.
See models for additional details and options.
:"claude-opus-4-5-20251101"
Premium model combining maximum intelligence with practical performance
:"claude-opus-4-5"
Premium model combining maximum intelligence with practical performance
:"claude-3-7-sonnet-latest"
High-performance model with early extended thinking
:"claude-3-7-sonnet-20250219"
High-performance model with early extended thinking
:"claude-3-5-haiku-latest"
Fastest and most compact model for near-instant responsiveness
:"claude-3-5-haiku-20241022"
Our fastest model
:"claude-haiku-4-5"
Hybrid model, capable of near-instant responses and extended thinking
:"claude-haiku-4-5-20251001"
Hybrid model, capable of near-instant responses and extended thinking
:"claude-sonnet-4-20250514"
High-performance model with extended thinking
:"claude-sonnet-4-0"
High-performance model with extended thinking
:"claude-4-sonnet-20250514"
High-performance model with extended thinking
:"claude-sonnet-4-5"
Our best model for real-world agents and coding
:"claude-sonnet-4-5-20250929"
Our best model for real-world agents and coding
:"claude-opus-4-0"
Our most capable model
:"claude-opus-4-20250514"
Our most capable model
:"claude-4-opus-20250514"
Our most capable model
:"claude-opus-4-1-20250805"
Our most capable model
:"claude-3-opus-latest"
Excels at writing and complex tasks
:"claude-3-opus-20240229"
Excels at writing and complex tasks
:"claude-3-haiku-20240307"
Our previous most fast and cost-effective
role: :assistant
Conversational role of the generated message.
This will always be "assistant".
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
stop_sequence: String
Which custom stop sequence was generated, if any.
This value will be a non-null string if one of your custom stop sequences was generated.
type: :message
Object type.
For Messages, this is always "message".
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
Breakdown of cached tokens by TTL
ephemeral_1h_input_tokens: Integer
The number of input tokens used to create the 1 hour cache entry.
ephemeral_5m_input_tokens: Integer
The number of input tokens used to create the 5 minute cache entry.
cache_creation_input_tokens: Integer
The number of input tokens used to create the cache entry.
cache_read_input_tokens: Integer
The number of input tokens read from the cache.
input_tokens: Integer
The number of input tokens which were used.
output_tokens: Integer
The number of output tokens which were used.
The number of server tool requests.
web_fetch_requests: Integer
The number of web fetch tool requests.
web_search_requests: Integer
The number of web search tool requests.
service_tier: :standard | :priority | :batch
If the request used the priority, standard, or batch tier.
type: :succeeded
class BetaMessageBatchErroredResult { error, type }
class BetaInvalidRequestError { message, type }
type: :invalid_request_error
class BetaAuthenticationError { message, type }
type: :authentication_error
class BetaBillingError { message, type }
type: :billing_error
class BetaPermissionError { message, type }
type: :permission_error
class BetaNotFoundError { message, type }
type: :not_found_error
class BetaRateLimitError { message, type }
type: :rate_limit_error
class BetaGatewayTimeoutError { message, type }
type: :timeout_error
class BetaAPIError { message, type }
type: :api_error
class BetaOverloadedError { message, type }
type: :overloaded_error
type: :error
type: :errored
class BetaMessageBatchCanceledResult { type }
type: :canceled
class BetaMessageBatchExpiredResult { type }
type: :expired
class BetaMessageBatchRequestCounts { canceled, errored, expired, 2 more }
canceled: Integer
Number of requests in the Message Batch that have been canceled.
This is zero until processing of the entire Message Batch has ended.
errored: Integer
Number of requests in the Message Batch that encountered an error.
This is zero until processing of the entire Message Batch has ended.
expired: Integer
Number of requests in the Message Batch that have expired.
This is zero until processing of the entire Message Batch has ended.
processing: Integer
Number of requests in the Message Batch that are processing.
succeeded: Integer
Number of requests in the Message Batch that have completed successfully.
This is zero until processing of the entire Message Batch has ended.
BetaMessageBatchResult = BetaMessageBatchSucceededResult { message, type } | BetaMessageBatchErroredResult { error, type } | BetaMessageBatchCanceledResult { type } | BetaMessageBatchExpiredResult { type }
Processing result for this request.
Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration.
class BetaMessageBatchSucceededResult { message, type }
id: String
Unique object identifier.
The format and length of IDs may change over time.
Information about the container used in the request (for the code execution tool)
id: String
Identifier for the container used in this request
expires_at: Time
The time at which the container will expire.
Skills loaded in the container
skill_id: String
Skill ID
type: :anthropic | :custom
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
version: String
Skill version or 'latest' for most recent version
Content generated by the model.
This is an array of content blocks, each of which has a type that determines its shape.
Example:
[{"type": "text", "text": "Hi, I'm Claude."}]
If the request input messages ended with an assistant turn, then the response content will continue directly from that last turn. You can use this to constrain the model's output.
For example, if the input messages were:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("}
]
Then the response content might be:
[{"type": "text", "text": "B)"}]
class BetaTextBlock { citations, text, type }
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: :char_location
class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: :page_location
class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: :content_block_location
class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :text
class BetaThinkingBlock { signature, thinking, type }
type: :thinking
class BetaRedactedThinkingBlock { data, type }
type: :redacted_thinking
class BetaToolUseBlock { id, input, name, 2 more }
type: :tool_use
Tool invocation directly from the model.
class BetaDirectCaller { type }
Tool invocation directly from the model.
type: :direct
class BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: :code_execution_20250825
class BetaServerToolUseBlock { id, caller_, input, 2 more }
Tool invocation directly from the model.
class BetaDirectCaller { type }
Tool invocation directly from the model.
type: :direct
class BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: :code_execution_20250825
name: :web_search | :web_fetch | :code_execution | 4 more
type: :server_tool_use
class BetaWebSearchToolResultBlock { content, tool_use_id, type }
class BetaWebSearchToolResultError { error_code, type }
type: :web_search_tool_result_error
Array[BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more } ]
type: :web_search_result
type: :web_search_tool_result
class BetaWebFetchToolResultBlock { content, tool_use_id, type }
content: BetaWebFetchToolResultErrorBlock { error_code, type } | BetaWebFetchBlock { content, retrieved_at, type, url }
class BetaWebFetchToolResultErrorBlock { error_code, type }
type: :web_fetch_tool_result_error
class BetaWebFetchBlock { content, retrieved_at, type, url }
Citation configuration for the document
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type }
class BetaBase64PDFSource { data, media_type, type }
media_type: :"application/pdf"
type: :base64
class BetaPlainTextSource { data, media_type, type }
media_type: :"text/plain"
type: :text
title: String
The title of the document
type: :document
retrieved_at: String
ISO 8601 timestamp when the content was retrieved
type: :web_fetch_result
url: String
Fetched content URL
type: :web_fetch_tool_result
class BetaCodeExecutionToolResultBlock { content, tool_use_id, type }
class BetaCodeExecutionToolResultError { error_code, type }
type: :code_execution_tool_result_error
class BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }
type: :code_execution_output
type: :code_execution_result
type: :code_execution_tool_result
class BetaBashCodeExecutionToolResultBlock { content, tool_use_id, type }
content: BetaBashCodeExecutionToolResultError { error_code, type } | BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
class BetaBashCodeExecutionToolResultError { error_code, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :bash_code_execution_tool_result_error
class BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
type: :bash_code_execution_output
type: :bash_code_execution_result
type: :bash_code_execution_tool_result
class BetaTextEditorCodeExecutionToolResultBlock { content, tool_use_id, type }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } | BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } | BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } | BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
class BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :text_editor_code_execution_tool_result_error
class BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more }
file_type: :text | :image | :pdf
type: :text_editor_code_execution_view_result
class BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type }
type: :text_editor_code_execution_create_result
class BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
type: :text_editor_code_execution_str_replace_result
type: :text_editor_code_execution_tool_result
class BetaToolSearchToolResultBlock { content, tool_use_id, type }
content: BetaToolSearchToolResultError { error_code, error_message, type } | BetaToolSearchToolSearchResultBlock { tool_references, type }
class BetaToolSearchToolResultError { error_code, error_message, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | :execution_time_exceeded
type: :tool_search_tool_result_error
class BetaToolSearchToolSearchResultBlock { tool_references, type }
type: :tool_reference
type: :tool_search_tool_search_result
type: :tool_search_tool_result
class BetaMCPToolUseBlock { id, input, name, 2 more }
name: String
The name of the MCP tool
server_name: String
The name of the MCP server
type: :mcp_tool_use
class BetaMCPToolResultBlock { content, is_error, tool_use_id, type }
Array[BetaTextBlock { citations, text, type } ]
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: :char_location
class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: :page_location
class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: :content_block_location
class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :text
type: :mcp_tool_result
class BetaContainerUploadBlock { file_id, type }
Response model for a file uploaded to the container.
type: :container_upload
Context management response.
Information about context management strategies applied during the request.
applied_edits: Array[BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } | BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type } ]
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type }
cleared_input_tokens: Integer
Number of input tokens cleared by this edit.
cleared_tool_uses: Integer
Number of tool uses that were cleared.
type: :clear_tool_uses_20250919
The type of context management edit applied.
class BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }
cleared_input_tokens: Integer
Number of input tokens cleared by this edit.
cleared_thinking_turns: Integer
Number of thinking turns that were cleared.
type: :clear_thinking_20251015
The type of context management edit applied.
The model that will complete your prompt.
See models for additional details and options.
:"claude-opus-4-5-20251101" | :"claude-opus-4-5" | :"claude-3-7-sonnet-latest" | 17 more
The model that will complete your prompt.
See models for additional details and options.
:"claude-opus-4-5-20251101"
Premium model combining maximum intelligence with practical performance
:"claude-opus-4-5"
Premium model combining maximum intelligence with practical performance
:"claude-3-7-sonnet-latest"
High-performance model with early extended thinking
:"claude-3-7-sonnet-20250219"
High-performance model with early extended thinking
:"claude-3-5-haiku-latest"
Fastest and most compact model for near-instant responsiveness
:"claude-3-5-haiku-20241022"
Our fastest model
:"claude-haiku-4-5"
Hybrid model, capable of near-instant responses and extended thinking
:"claude-haiku-4-5-20251001"
Hybrid model, capable of near-instant responses and extended thinking
:"claude-sonnet-4-20250514"
High-performance model with extended thinking
:"claude-sonnet-4-0"
High-performance model with extended thinking
:"claude-4-sonnet-20250514"
High-performance model with extended thinking
:"claude-sonnet-4-5"
Our best model for real-world agents and coding
:"claude-sonnet-4-5-20250929"
Our best model for real-world agents and coding
:"claude-opus-4-0"
Our most capable model
:"claude-opus-4-20250514"
Our most capable model
:"claude-4-opus-20250514"
Our most capable model
:"claude-opus-4-1-20250805"
Our most capable model
:"claude-3-opus-latest"
Excels at writing and complex tasks
:"claude-3-opus-20240229"
Excels at writing and complex tasks
:"claude-3-haiku-20240307"
Our previous most fast and cost-effective
role: :assistant
Conversational role of the generated message.
This will always be "assistant".
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
stop_sequence: String
Which custom stop sequence was generated, if any.
This value will be a non-null string if one of your custom stop sequences was generated.
type: :message
Object type.
For Messages, this is always "message".
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
Breakdown of cached tokens by TTL
ephemeral_1h_input_tokens: Integer
The number of input tokens used to create the 1 hour cache entry.
ephemeral_5m_input_tokens: Integer
The number of input tokens used to create the 5 minute cache entry.
cache_creation_input_tokens: Integer
The number of input tokens used to create the cache entry.
cache_read_input_tokens: Integer
The number of input tokens read from the cache.
input_tokens: Integer
The number of input tokens which were used.
output_tokens: Integer
The number of output tokens which were used.
The number of server tool requests.
web_fetch_requests: Integer
The number of web fetch tool requests.
web_search_requests: Integer
The number of web search tool requests.
service_tier: :standard | :priority | :batch
If the request used the priority, standard, or batch tier.
type: :succeeded
class BetaMessageBatchErroredResult { error, type }
class BetaInvalidRequestError { message, type }
type: :invalid_request_error
class BetaAuthenticationError { message, type }
type: :authentication_error
class BetaBillingError { message, type }
type: :billing_error
class BetaPermissionError { message, type }
type: :permission_error
class BetaNotFoundError { message, type }
type: :not_found_error
class BetaRateLimitError { message, type }
type: :rate_limit_error
class BetaGatewayTimeoutError { message, type }
type: :timeout_error
class BetaAPIError { message, type }
type: :api_error
class BetaOverloadedError { message, type }
type: :overloaded_error
type: :error
type: :errored
class BetaMessageBatchCanceledResult { type }
type: :canceled
class BetaMessageBatchExpiredResult { type }
type: :expired
class BetaMessageBatchSucceededResult { message, type }
id: String
Unique object identifier.
The format and length of IDs may change over time.
Information about the container used in the request (for the code execution tool)
id: String
Identifier for the container used in this request
expires_at: Time
The time at which the container will expire.
Skills loaded in the container
skill_id: String
Skill ID
type: :anthropic | :custom
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
version: String
Skill version or 'latest' for most recent version
Content generated by the model.
This is an array of content blocks, each of which has a type that determines its shape.
Example:
[{"type": "text", "text": "Hi, I'm Claude."}]
If the request input messages ended with an assistant turn, then the response content will continue directly from that last turn. You can use this to constrain the model's output.
For example, if the input messages were:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("}
]
Then the response content might be:
[{"type": "text", "text": "B)"}]
class BetaTextBlock { citations, text, type }
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: :char_location
class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: :page_location
class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: :content_block_location
class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :text
class BetaThinkingBlock { signature, thinking, type }
type: :thinking
class BetaRedactedThinkingBlock { data, type }
type: :redacted_thinking
class BetaToolUseBlock { id, input, name, 2 more }
type: :tool_use
Tool invocation directly from the model.
class BetaDirectCaller { type }
Tool invocation directly from the model.
type: :direct
class BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: :code_execution_20250825
class BetaServerToolUseBlock { id, caller_, input, 2 more }
Tool invocation directly from the model.
class BetaDirectCaller { type }
Tool invocation directly from the model.
type: :direct
class BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: :code_execution_20250825
name: :web_search | :web_fetch | :code_execution | 4 more
type: :server_tool_use
class BetaWebSearchToolResultBlock { content, tool_use_id, type }
class BetaWebSearchToolResultError { error_code, type }
type: :web_search_tool_result_error
Array[BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more } ]
type: :web_search_result
type: :web_search_tool_result
class BetaWebFetchToolResultBlock { content, tool_use_id, type }
content: BetaWebFetchToolResultErrorBlock { error_code, type } | BetaWebFetchBlock { content, retrieved_at, type, url }
class BetaWebFetchToolResultErrorBlock { error_code, type }
type: :web_fetch_tool_result_error
class BetaWebFetchBlock { content, retrieved_at, type, url }
Citation configuration for the document
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type }
class BetaBase64PDFSource { data, media_type, type }
media_type: :"application/pdf"
type: :base64
class BetaPlainTextSource { data, media_type, type }
media_type: :"text/plain"
type: :text
title: String
The title of the document
type: :document
retrieved_at: String
ISO 8601 timestamp when the content was retrieved
type: :web_fetch_result
url: String
Fetched content URL
type: :web_fetch_tool_result
class BetaCodeExecutionToolResultBlock { content, tool_use_id, type }
class BetaCodeExecutionToolResultError { error_code, type }
type: :code_execution_tool_result_error
class BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }
type: :code_execution_output
type: :code_execution_result
type: :code_execution_tool_result
class BetaBashCodeExecutionToolResultBlock { content, tool_use_id, type }
content: BetaBashCodeExecutionToolResultError { error_code, type } | BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
class BetaBashCodeExecutionToolResultError { error_code, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :bash_code_execution_tool_result_error
class BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
type: :bash_code_execution_output
type: :bash_code_execution_result
type: :bash_code_execution_tool_result
class BetaTextEditorCodeExecutionToolResultBlock { content, tool_use_id, type }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } | BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } | BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } | BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
class BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :text_editor_code_execution_tool_result_error
class BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more }
file_type: :text | :image | :pdf
type: :text_editor_code_execution_view_result
class BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type }
type: :text_editor_code_execution_create_result
class BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
type: :text_editor_code_execution_str_replace_result
type: :text_editor_code_execution_tool_result
class BetaToolSearchToolResultBlock { content, tool_use_id, type }
content: BetaToolSearchToolResultError { error_code, error_message, type } | BetaToolSearchToolSearchResultBlock { tool_references, type }
class BetaToolSearchToolResultError { error_code, error_message, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | :execution_time_exceeded
type: :tool_search_tool_result_error
class BetaToolSearchToolSearchResultBlock { tool_references, type }
type: :tool_reference
type: :tool_search_tool_search_result
type: :tool_search_tool_result
class BetaMCPToolUseBlock { id, input, name, 2 more }
name: String
The name of the MCP tool
server_name: String
The name of the MCP server
type: :mcp_tool_use
class BetaMCPToolResultBlock { content, is_error, tool_use_id, type }
Array[BetaTextBlock { citations, text, type } ]
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: :char_location
class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: :page_location
class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: :content_block_location
class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :text
type: :mcp_tool_result
class BetaContainerUploadBlock { file_id, type }
Response model for a file uploaded to the container.
type: :container_upload
Context management response.
Information about context management strategies applied during the request.
applied_edits: Array[BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } | BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type } ]
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type }
cleared_input_tokens: Integer
Number of input tokens cleared by this edit.
cleared_tool_uses: Integer
Number of tool uses that were cleared.
type: :clear_tool_uses_20250919
The type of context management edit applied.
class BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }
cleared_input_tokens: Integer
Number of input tokens cleared by this edit.
cleared_thinking_turns: Integer
Number of thinking turns that were cleared.
type: :clear_thinking_20251015
The type of context management edit applied.
The model that will complete your prompt.
See models for additional details and options.
:"claude-opus-4-5-20251101" | :"claude-opus-4-5" | :"claude-3-7-sonnet-latest" | 17 more
The model that will complete your prompt.
See models for additional details and options.
:"claude-opus-4-5-20251101"
Premium model combining maximum intelligence with practical performance
:"claude-opus-4-5"
Premium model combining maximum intelligence with practical performance
:"claude-3-7-sonnet-latest"
High-performance model with early extended thinking
:"claude-3-7-sonnet-20250219"
High-performance model with early extended thinking
:"claude-3-5-haiku-latest"
Fastest and most compact model for near-instant responsiveness
:"claude-3-5-haiku-20241022"
Our fastest model
:"claude-haiku-4-5"
Hybrid model, capable of near-instant responses and extended thinking
:"claude-haiku-4-5-20251001"
Hybrid model, capable of near-instant responses and extended thinking
:"claude-sonnet-4-20250514"
High-performance model with extended thinking
:"claude-sonnet-4-0"
High-performance model with extended thinking
:"claude-4-sonnet-20250514"
High-performance model with extended thinking
:"claude-sonnet-4-5"
Our best model for real-world agents and coding
:"claude-sonnet-4-5-20250929"
Our best model for real-world agents and coding
:"claude-opus-4-0"
Our most capable model
:"claude-opus-4-20250514"
Our most capable model
:"claude-4-opus-20250514"
Our most capable model
:"claude-opus-4-1-20250805"
Our most capable model
:"claude-3-opus-latest"
Excels at writing and complex tasks
:"claude-3-opus-20240229"
Excels at writing and complex tasks
:"claude-3-haiku-20240307"
Our previous most fast and cost-effective
role: :assistant
Conversational role of the generated message.
This will always be "assistant".
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
stop_sequence: String
Which custom stop sequence was generated, if any.
This value will be a non-null string if one of your custom stop sequences was generated.
type: :message
Object type.
For Messages, this is always "message".
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
Breakdown of cached tokens by TTL
ephemeral_1h_input_tokens: Integer
The number of input tokens used to create the 1 hour cache entry.
ephemeral_5m_input_tokens: Integer
The number of input tokens used to create the 5 minute cache entry.
cache_creation_input_tokens: Integer
The number of input tokens used to create the cache entry.
cache_read_input_tokens: Integer
The number of input tokens read from the cache.
input_tokens: Integer
The number of input tokens which were used.
output_tokens: Integer
The number of output tokens which were used.
The number of server tool requests.
web_fetch_requests: Integer
The number of web fetch tool requests.
web_search_requests: Integer
The number of web search tool requests.
service_tier: :standard | :priority | :batch
If the request used the priority, standard, or batch tier.
type: :succeeded
BetaFiles
Upload File
List Files
Get File Metadata
Delete File
ModelsExpand Collapse
class DeletedFile { id, type }
id: String
ID of the deleted file.
type: :file_deleted
Deleted object type.
For file deletion, this is always "file_deleted".
class FileMetadata { id, created_at, filename, 4 more }
id: String
Unique object identifier.
The format and length of IDs may change over time.
created_at: Time
RFC 3339 datetime string representing when the file was created.
filename: String
Original filename of the uploaded file.
mime_type: String
MIME type of the file.
size_bytes: Integer
Size of the file in bytes.
type: :file
Object type.
For files, this is always "file".
downloadable: bool
Whether the file can be downloaded.