Create a Message
Send a structured list of input messages with text and/or image content, and the model will generate the next message in the conversation.
The Messages API can be used for either single queries or stateless multi-turn conversations.
Learn more about the Messages API in our user guide
Body ParametersJSONExpand Collapse
max_tokens: numberThe maximum number of tokens to generate before stopping.
The maximum number of tokens to generate before stopping.
Note that our models may stop before reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate.
Different models have different maximum values for this parameter. See models for details.
messages: array of MessageParam { content, role } Input messages.
Input messages.
Our models are trained to operate on alternating user and assistant conversational turns. When creating a new Message, you specify the prior conversational turns with the messages parameter, and the model then generates the next Message in the conversation. Consecutive user or assistant turns in your request will be combined into a single turn.
Each input message must be an object with a role and content. You can specify a single user-role message, or you can include multiple user and assistant messages.
If the final message uses the assistant role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response.
Example with a single user message:
[{"role": "user", "content": "Hello, Claude"}]
Example with multiple conversational turns:
[
{"role": "user", "content": "Hello there."},
{"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"},
{"role": "user", "content": "Can you explain LLMs in plain English?"},
]
Example with a partially-filled response from Claude:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("},
]
Each input message content may be either a single string or an array of content blocks, where each block has a specific type. Using a string for content is shorthand for an array of one content block of type "text". The following input messages are equivalent:
{"role": "user", "content": "Hello, Claude"}
{"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]}
See input examples.
Note that if you want to include a system prompt, you can use the top-level system parameter — there is no "system" role for input messages in the Messages API.
There is a limit of 100,000 messages in a single request.
content: string or array of ContentBlockParam
UnionMember1 = array of ContentBlockParam
TextBlockParam = object { text, type, cache_control, citations }
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
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: optional array of TextCitationParam
CitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
CitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
CitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
CitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
CitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
ImageBlockParam = object { source, type, cache_control }
source: Base64ImageSource { data, media_type, type } or URLImageSource { type, url }
Base64ImageSource = object { data, media_type, type }
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
URLImageSource = object { type, url }
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
DocumentBlockParam = object { source, type, cache_control, 3 more }
source: Base64PDFSource { data, media_type, type } or PlainTextSource { data, media_type, type } or ContentBlockSource { content, type } or URLPDFSource { type, url }
Base64PDFSource = object { data, media_type, type }
PlainTextSource = object { data, media_type, type }
ContentBlockSource = object { content, type }
content: string or array of ContentBlockSourceContent
ContentBlockSourceContent = array of ContentBlockSourceContent
TextBlockParam = object { text, type, cache_control, citations }
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
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: optional array of TextCitationParam
CitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
CitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
CitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
CitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
CitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
ImageBlockParam = object { source, type, cache_control }
source: Base64ImageSource { data, media_type, type } or URLImageSource { type, url }
Base64ImageSource = object { data, media_type, type }
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
URLImageSource = object { type, url }
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
URLPDFSource = object { type, url }
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
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: optional CitationsConfigParam { enabled }
SearchResultBlockParam = object { content, source, title, 3 more }
content: array of TextBlockParam { text, type, cache_control, citations }
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
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: optional array of TextCitationParam
CitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
CitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
CitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
CitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
CitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
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: optional CitationsConfigParam { enabled }
ThinkingBlockParam = object { signature, thinking, type }
RedactedThinkingBlockParam = object { data, type }
ToolUseBlockParam = object { id, input, name, 3 more }
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
caller: optional DirectCaller { type } or ServerToolCaller { tool_id, type } or ServerToolCaller20260120 { tool_id, type } Tool invocation directly from the model.
Tool invocation directly from the model.
DirectCaller = object { type } Tool invocation directly from the model.
Tool invocation directly from the model.
ServerToolCaller = object { tool_id, type } Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
ServerToolCaller20260120 = object { tool_id, type }
ToolResultBlockParam = object { tool_use_id, type, cache_control, 2 more }
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
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: optional string or array of TextBlockParam { text, type, cache_control, citations } or ImageBlockParam { source, type, cache_control } or SearchResultBlockParam { content, source, title, 3 more } or 2 more
UnionMember1 = array of TextBlockParam { text, type, cache_control, citations } or ImageBlockParam { source, type, cache_control } or SearchResultBlockParam { content, source, title, 3 more } or 2 more
TextBlockParam = object { text, type, cache_control, citations }
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
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: optional array of TextCitationParam
CitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
CitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
CitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
CitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
CitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
ImageBlockParam = object { source, type, cache_control }
source: Base64ImageSource { data, media_type, type } or URLImageSource { type, url }
Base64ImageSource = object { data, media_type, type }
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
URLImageSource = object { type, url }
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
SearchResultBlockParam = object { content, source, title, 3 more }
content: array of TextBlockParam { text, type, cache_control, citations }
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
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: optional array of TextCitationParam
CitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
CitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
CitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
CitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
CitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
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: optional CitationsConfigParam { enabled }
DocumentBlockParam = object { source, type, cache_control, 3 more }
source: Base64PDFSource { data, media_type, type } or PlainTextSource { data, media_type, type } or ContentBlockSource { content, type } or URLPDFSource { type, url }
Base64PDFSource = object { data, media_type, type }
PlainTextSource = object { data, media_type, type }
ContentBlockSource = object { content, type }
content: string or array of ContentBlockSourceContent
ContentBlockSourceContent = array of ContentBlockSourceContent
TextBlockParam = object { text, type, cache_control, citations }
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
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: optional array of TextCitationParam
CitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
CitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
CitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
CitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
CitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
ImageBlockParam = object { source, type, cache_control }
source: Base64ImageSource { data, media_type, type } or URLImageSource { type, url }
Base64ImageSource = object { data, media_type, type }
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
URLImageSource = object { type, url }
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
URLPDFSource = object { type, url }
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
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: optional CitationsConfigParam { enabled }
ToolReferenceBlockParam = object { tool_name, type, cache_control } Tool reference block that can be included in tool_result content.
Tool reference block that can be included in tool_result content.
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
ServerToolUseBlockParam = object { id, input, name, 3 more }
name: "web_search" or "web_fetch" or "code_execution" or 4 more
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
caller: optional DirectCaller { type } or ServerToolCaller { tool_id, type } or ServerToolCaller20260120 { tool_id, type } Tool invocation directly from the model.
Tool invocation directly from the model.
DirectCaller = object { type } Tool invocation directly from the model.
Tool invocation directly from the model.
ServerToolCaller = object { tool_id, type } Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
ServerToolCaller20260120 = object { tool_id, type }
WebSearchToolResultBlockParam = object { content, tool_use_id, type, 2 more }
content: WebSearchToolResultBlockParamContent
WebSearchToolResultBlockItem = array of WebSearchResultBlockParam { encrypted_content, title, type, 2 more }
WebSearchToolRequestError = object { error_code, type }
error_code: WebSearchToolResultErrorCode
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
caller: optional DirectCaller { type } or ServerToolCaller { tool_id, type } or ServerToolCaller20260120 { tool_id, type } Tool invocation directly from the model.
Tool invocation directly from the model.
DirectCaller = object { type } Tool invocation directly from the model.
Tool invocation directly from the model.
ServerToolCaller = object { tool_id, type } Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
ServerToolCaller20260120 = object { tool_id, type }
WebFetchToolResultBlockParam = object { content, tool_use_id, type, 2 more }
content: WebFetchToolResultErrorBlockParam { error_code, type } or WebFetchBlockParam { content, type, url, retrieved_at }
WebFetchToolResultErrorBlockParam = object { error_code, type }
error_code: WebFetchToolResultErrorCode
WebFetchBlockParam = object { content, type, url, retrieved_at }
content: DocumentBlockParam { source, type, cache_control, 3 more }
source: Base64PDFSource { data, media_type, type } or PlainTextSource { data, media_type, type } or ContentBlockSource { content, type } or URLPDFSource { type, url }
Base64PDFSource = object { data, media_type, type }
PlainTextSource = object { data, media_type, type }
ContentBlockSource = object { content, type }
content: string or array of ContentBlockSourceContent
ContentBlockSourceContent = array of ContentBlockSourceContent
TextBlockParam = object { text, type, cache_control, citations }
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
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: optional array of TextCitationParam
CitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
CitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
CitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
CitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
CitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
ImageBlockParam = object { source, type, cache_control }
source: Base64ImageSource { data, media_type, type } or URLImageSource { type, url }
Base64ImageSource = object { data, media_type, type }
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
URLImageSource = object { type, url }
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
URLPDFSource = object { type, url }
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
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: optional CitationsConfigParam { enabled }
Fetched content URL
ISO 8601 timestamp when the content was retrieved
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
caller: optional DirectCaller { type } or ServerToolCaller { tool_id, type } or ServerToolCaller20260120 { tool_id, type } Tool invocation directly from the model.
Tool invocation directly from the model.
DirectCaller = object { type } Tool invocation directly from the model.
Tool invocation directly from the model.
ServerToolCaller = object { tool_id, type } Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
ServerToolCaller20260120 = object { tool_id, type }
CodeExecutionToolResultBlockParam = object { content, tool_use_id, type, cache_control }
Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
CodeExecutionToolResultErrorParam = object { error_code, type }
error_code: CodeExecutionToolResultErrorCode
CodeExecutionResultBlockParam = object { content, return_code, stderr, 2 more }
content: array of CodeExecutionOutputBlockParam { file_id, type }
EncryptedCodeExecutionResultBlockParam = object { content, encrypted_stdout, return_code, 2 more } Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
content: array of CodeExecutionOutputBlockParam { file_id, type }
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BashCodeExecutionToolResultBlockParam = object { content, tool_use_id, type, cache_control }
content: BashCodeExecutionToolResultErrorParam { error_code, type } or BashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
BashCodeExecutionToolResultErrorParam = object { error_code, type }
error_code: BashCodeExecutionToolResultErrorCode
BashCodeExecutionResultBlockParam = object { content, return_code, stderr, 2 more }
content: array of BashCodeExecutionOutputBlockParam { file_id, type }
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
TextEditorCodeExecutionToolResultBlockParam = object { content, tool_use_id, type, cache_control }
content: TextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message } or TextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more } or TextEditorCodeExecutionCreateResultBlockParam { is_file_update, type } or TextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }
TextEditorCodeExecutionToolResultErrorParam = object { error_code, type, error_message }
error_code: TextEditorCodeExecutionToolResultErrorCode
TextEditorCodeExecutionViewResultBlockParam = object { content, file_type, type, 3 more }
file_type: "text" or "image" or "pdf"
TextEditorCodeExecutionCreateResultBlockParam = object { is_file_update, type }
TextEditorCodeExecutionStrReplaceResultBlockParam = object { type, lines, new_lines, 3 more }
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
ToolSearchToolResultBlockParam = object { content, tool_use_id, type, cache_control }
content: ToolSearchToolResultErrorParam { error_code, type } or ToolSearchToolSearchResultBlockParam { tool_references, type }
ToolSearchToolResultErrorParam = object { error_code, type }
error_code: ToolSearchToolResultErrorCode
ToolSearchToolSearchResultBlockParam = object { tool_references, type }
tool_references: array of ToolReferenceBlockParam { tool_name, type, cache_control }
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
ContainerUploadBlockParam = object { 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.
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.
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
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" or "assistant"
model: ModelThe model that will complete your prompt.
The model that will complete your prompt.
See models for additional details and options.
UnionMember0 = "claude-opus-4-6" or "claude-sonnet-4-6" or "claude-haiku-4-5" or 12 moreThe model that will complete your prompt.
The model that will complete your prompt.
See models for additional details and options.
Most intelligent model for building agents and coding
Best combination of speed and intelligence
Fastest model with near-frontier intelligence
Fastest model with near-frontier intelligence
Premium model combining maximum intelligence with practical performance
Premium model combining maximum intelligence with practical performance
High-performance model for agents and coding
High-performance model for agents and coding
Exceptional model for specialized complex tasks
Exceptional model for specialized complex tasks
Powerful model for complex tasks
Powerful model for complex tasks
High-performance model with extended thinking
High-performance model with extended thinking
Fast and cost-effective model
cache_control: optional CacheControlEphemeral { type, ttl } Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request.
Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Container identifier for reuse across requests.
Specifies the geographic region for inference processing. If not specified, the workspace's default_inference_geo is used.
metadata: optional Metadata { user_id } An object describing metadata about the request.
An object describing metadata about the request.
user_id: optional stringAn external identifier for the user who is associated with the request.
An external identifier for the user who is associated with the request.
This should be a uuid, hash value, or other opaque identifier. Anthropic may use this id to help detect abuse. Do not include any identifying information such as name, email address, or phone number.
output_config: optional OutputConfig { effort, format } Configuration options for the model's output, such as the output format.
Configuration options for the model's output, such as the output format.
effort: optional "low" or "medium" or "high" or "max"All possible effort levels.
All possible effort levels.
format: optional JSONOutputFormat { schema, type } A schema to specify Claude's output format in responses. See structured outputs
A schema to specify Claude's output format in responses. See structured outputs
The JSON schema of the format
service_tier: optional "auto" or "standard_only"Determines whether to use priority capacity (if available) or standard capacity for this request.
Determines whether to use priority capacity (if available) or standard capacity for this request.
Anthropic offers different levels of service for your API requests. See service-tiers for details.
stop_sequences: optional array of stringCustom text sequences that will cause the model to stop generating.
Custom text sequences that will cause the model to stop generating.
Our models will normally stop when they have naturally completed their turn, which will result in a response stop_reason of "end_turn".
If you want the model to stop generating when it encounters custom strings of text, you can use the stop_sequences parameter. If the model encounters one of the custom sequences, the response stop_reason value will be "stop_sequence" and the response stop_sequence value will contain the matched stop sequence.
stream: optional booleanWhether to incrementally stream the response using server-sent events.
Whether to incrementally stream the response using server-sent events.
See streaming for details.
system: optional string or array of TextBlockParam { text, type, cache_control, citations } System prompt.
System prompt.
A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our guide to system prompts.
UnionMember1 = array of TextBlockParam { text, type, cache_control, citations }
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
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: optional array of TextCitationParam
CitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
CitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
CitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
CitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
CitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
temperature: optional numberAmount of randomness injected into the response.
Amount of randomness injected into the response.
Defaults to 1.0. Ranges from 0.0 to 1.0. Use temperature closer to 0.0 for analytical / multiple choice, and closer to 1.0 for creative and generative tasks.
Note that even with temperature of 0.0, the results will not be fully deterministic.
thinking: optional ThinkingConfigParamConfiguration for enabling Claude's extended thinking.
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.
ThinkingConfigEnabled = object { budget_tokens, type, display }
budget_tokens: numberDetermines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality.
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.
display: optional "summarized" or "omitted"Controls how thinking content appears in the response. When set to summarized, thinking is returned normally. When set to omitted, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to summarized.
Controls how thinking content appears in the response. When set to summarized, thinking is returned normally. When set to omitted, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to summarized.
ThinkingConfigDisabled = object { type }
ThinkingConfigAdaptive = object { type, display }
display: optional "summarized" or "omitted"Controls how thinking content appears in the response. When set to summarized, thinking is returned normally. When set to omitted, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to summarized.
Controls how thinking content appears in the response. When set to summarized, thinking is returned normally. When set to omitted, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to summarized.
tool_choice: optional ToolChoiceHow 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.
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.
ToolChoiceAuto = object { type, disable_parallel_tool_use } The model will automatically decide whether to use tools.
The model will automatically decide whether to use tools.
disable_parallel_tool_use: optional booleanWhether to disable parallel tool use.
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output at most one tool use.
ToolChoiceAny = object { type, disable_parallel_tool_use } The model will use any available tools.
The model will use any available tools.
disable_parallel_tool_use: optional booleanWhether to disable parallel tool use.
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
ToolChoiceTool = object { name, type, disable_parallel_tool_use } The model will use the specified tool with tool_choice.name.
The model will use the specified tool with tool_choice.name.
The name of the tool to use.
disable_parallel_tool_use: optional booleanWhether to disable parallel tool use.
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
ToolChoiceNone = object { type } The model will not be allowed to use tools.
The model will not be allowed to use tools.
tools: optional array of ToolUnionDefinitions of tools that the model may use.
Definitions of tools that the model may use.
If you include tools in your API request, the model may return tool_use content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using tool_result content blocks.
There are two types of tools: client tools and server tools. The behavior described below applies to client tools. For server tools, see their individual documentation as each has its own behavior (e.g., the web search tool).
Each tool definition includes:
name: Name of the tool.description: Optional, but strongly-recommended description of the tool.input_schema: JSON schema for the toolinputshape that the model will produce intool_useoutput content blocks.
For example, if you defined tools as:
[
{
"name": "get_stock_price",
"description": "Get the current stock price for a given ticker symbol.",
"input_schema": {
"type": "object",
"properties": {
"ticker": {
"type": "string",
"description": "The stock ticker symbol, e.g. AAPL for Apple Inc."
}
},
"required": ["ticker"]
}
}
]
And then asked the model "What's the S&P 500 at today?", the model might produce tool_use content blocks in the response like this:
[
{
"type": "tool_use",
"id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
"name": "get_stock_price",
"input": { "ticker": "^GSPC" }
}
]
You might then run your get_stock_price tool with {"ticker": "^GSPC"} as an input, and return the following back to the model in a subsequent user message:
[
{
"type": "tool_result",
"tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
"content": "259.75 USD"
}
]
Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output.
See our guide for more details.
Tool = object { input_schema, name, allowed_callers, 7 more }
input_schema: object { type, properties, required } JSON schema for this tool's input.
JSON schema for this tool's input.
This defines the shape of the input that your tool accepts and that the model will produce.
name: stringName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
description: optional stringDescription of what this tool does.
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.
Enable eager input streaming for this tool. When true, tool input parameters will be streamed incrementally as they are generated, and types will be inferred on-the-fly rather than buffering the full JSON output. When false, streaming is disabled for this tool even if the fine-grained-tool-streaming beta is active. When null (default), uses the default behavior based on beta headers.
When true, guarantees schema validation on tool names and inputs
ToolBash20250124 = object { name, type, allowed_callers, 4 more }
name: "bash"Name of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
CodeExecutionTool20250522 = object { name, type, allowed_callers, 3 more }
name: "code_execution"Name of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
CodeExecutionTool20250825 = object { name, type, allowed_callers, 3 more }
name: "code_execution"Name of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
CodeExecutionTool20260120 = object { name, type, allowed_callers, 3 more } Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
name: "code_execution"Name of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
MemoryTool20250818 = object { name, type, allowed_callers, 4 more }
name: "memory"Name of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
ToolTextEditor20250124 = object { name, type, allowed_callers, 4 more }
name: "str_replace_editor"Name of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
ToolTextEditor20250429 = object { name, type, allowed_callers, 4 more }
name: "str_replace_based_edit_tool"Name of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
ToolTextEditor20250728 = object { name, type, allowed_callers, 5 more }
name: "str_replace_based_edit_tool"Name of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.
When true, guarantees schema validation on tool names and inputs
WebSearchTool20250305 = object { name, type, allowed_callers, 7 more }
name: "web_search"Name of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"
If provided, only these domains will be included in results. Cannot be used alongside blocked_domains.
If provided, these domains will never appear in results. Cannot be used alongside allowed_domains.
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Maximum number of times the tool can be used in the API request.
When true, guarantees schema validation on tool names and inputs
user_location: optional UserLocation { type, city, country, 2 more } Parameters for the user's location. Used to provide more relevant search results.
Parameters for the user's location. Used to provide more relevant search results.
The city of the user.
The two letter ISO country code of the user.
The region of the user.
The IANA timezone of the user.
WebFetchTool20250910 = object { name, type, allowed_callers, 8 more }
name: "web_fetch"Name of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"
List of domains to allow fetching from
List of domains to block fetching from
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
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: optional CitationsConfigParam { enabled } Citations configuration for fetched documents. Citations are disabled by default.
Citations configuration for fetched documents. Citations are disabled by default.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
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.
Maximum number of times the tool can be used in the API request.
When true, guarantees schema validation on tool names and inputs
WebSearchTool20260209 = object { name, type, allowed_callers, 7 more }
name: "web_search"Name of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"
If provided, only these domains will be included in results. Cannot be used alongside blocked_domains.
If provided, these domains will never appear in results. Cannot be used alongside allowed_domains.
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Maximum number of times the tool can be used in the API request.
When true, guarantees schema validation on tool names and inputs
user_location: optional UserLocation { type, city, country, 2 more } Parameters for the user's location. Used to provide more relevant search results.
Parameters for the user's location. Used to provide more relevant search results.
The city of the user.
The two letter ISO country code of the user.
The region of the user.
The IANA timezone of the user.
WebFetchTool20260209 = object { name, type, allowed_callers, 8 more }
name: "web_fetch"Name of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"
List of domains to allow fetching from
List of domains to block fetching from
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
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: optional CitationsConfigParam { enabled } Citations configuration for fetched documents. Citations are disabled by default.
Citations configuration for fetched documents. Citations are disabled by default.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
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.
Maximum number of times the tool can be used in the API request.
When true, guarantees schema validation on tool names and inputs
WebFetchTool20260309 = object { name, type, allowed_callers, 9 more } Web fetch tool with use_cache parameter for bypassing cached content.
Web fetch tool with use_cache parameter for bypassing cached content.
name: "web_fetch"Name of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"
List of domains to allow fetching from
List of domains to block fetching from
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
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: optional CitationsConfigParam { enabled } Citations configuration for fetched documents. Citations are disabled by default.
Citations configuration for fetched documents. Citations are disabled by default.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
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.
Maximum number of times the tool can be used in the API request.
When true, guarantees schema validation on tool names and inputs
Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.
ToolSearchToolBm25_20251119 = object { name, type, allowed_callers, 3 more }
name: "tool_search_tool_bm25"Name of the tool.
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" or "tool_search_tool_bm25"
allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
ToolSearchToolRegex20251119 = object { name, type, allowed_callers, 3 more }
name: "tool_search_tool_regex"Name of the tool.
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" or "tool_search_tool_regex"
allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"
cache_control: optional CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
top_k: optional numberOnly sample from the top K options for each subsequent token.
Only sample from the top K options for each subsequent token.
Used to remove "long tail" low probability responses. Learn more technical details here.
Recommended for advanced use cases only. You usually only need to use temperature.
top_p: optional numberUse nucleus sampling.
Use nucleus sampling.
In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by top_p. You should either alter temperature or top_p, but not both.
Recommended for advanced use cases only. You usually only need to use temperature.
ReturnsExpand Collapse
Message = object { id, container, content, 6 more }
id: stringUnique object identifier.
Unique object identifier.
The format and length of IDs may change over time.
container: Container { id, expires_at } Information about the container used in the request (for the code execution tool)
Information about the container used in the request (for the code execution tool)
Identifier for the container used in this request
The time at which the container will expire.
content: array of ContentBlockContent generated by the model.
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)"}]
TextBlock = object { citations, text, type }
citations: array of TextCitationCitations supporting the text block.
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.
CitationCharLocation = object { cited_text, document_index, document_title, 4 more }
CitationPageLocation = object { cited_text, document_index, document_title, 4 more }
CitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
CitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
CitationsSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
ThinkingBlock = object { signature, thinking, type }
RedactedThinkingBlock = object { data, type }
ToolUseBlock = object { id, caller, input, 2 more }
caller: DirectCaller { type } or ServerToolCaller { tool_id, type } or ServerToolCaller20260120 { tool_id, type } Tool invocation directly from the model.
Tool invocation directly from the model.
DirectCaller = object { type } Tool invocation directly from the model.
Tool invocation directly from the model.
ServerToolCaller = object { tool_id, type } Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
ServerToolCaller20260120 = object { tool_id, type }
ServerToolUseBlock = object { id, caller, input, 2 more }
caller: DirectCaller { type } or ServerToolCaller { tool_id, type } or ServerToolCaller20260120 { tool_id, type } Tool invocation directly from the model.
Tool invocation directly from the model.
DirectCaller = object { type } Tool invocation directly from the model.
Tool invocation directly from the model.
ServerToolCaller = object { tool_id, type } Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
ServerToolCaller20260120 = object { tool_id, type }
name: "web_search" or "web_fetch" or "code_execution" or 4 more
WebSearchToolResultBlock = object { caller, content, tool_use_id, type }
caller: DirectCaller { type } or ServerToolCaller { tool_id, type } or ServerToolCaller20260120 { tool_id, type } Tool invocation directly from the model.
Tool invocation directly from the model.
DirectCaller = object { type } Tool invocation directly from the model.
Tool invocation directly from the model.
ServerToolCaller = object { tool_id, type } Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
ServerToolCaller20260120 = object { tool_id, type }
content: WebSearchToolResultBlockContent
WebSearchToolResultError = object { error_code, type }
error_code: WebSearchToolResultErrorCode
UnionMember1 = array of WebSearchResultBlock { encrypted_content, page_age, title, 2 more }
WebFetchToolResultBlock = object { caller, content, tool_use_id, type }
caller: DirectCaller { type } or ServerToolCaller { tool_id, type } or ServerToolCaller20260120 { tool_id, type } Tool invocation directly from the model.
Tool invocation directly from the model.
DirectCaller = object { type } Tool invocation directly from the model.
Tool invocation directly from the model.
ServerToolCaller = object { tool_id, type } Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
ServerToolCaller20260120 = object { tool_id, type }
content: WebFetchToolResultErrorBlock { error_code, type } or WebFetchBlock { content, retrieved_at, type, url }
WebFetchToolResultErrorBlock = object { error_code, type }
error_code: WebFetchToolResultErrorCode
WebFetchBlock = object { content, retrieved_at, type, url }
content: DocumentBlock { citations, source, title, type }
citations: CitationsConfig { enabled } Citation configuration for the document
Citation configuration for the document
source: Base64PDFSource { data, media_type, type } or PlainTextSource { data, media_type, type }
Base64PDFSource = object { data, media_type, type }
PlainTextSource = object { data, media_type, type }
The title of the document
ISO 8601 timestamp when the content was retrieved
Fetched content URL
CodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: CodeExecutionToolResultBlockContentCode execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
CodeExecutionToolResultError = object { error_code, type }
error_code: CodeExecutionToolResultErrorCode
CodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
content: array of CodeExecutionOutputBlock { file_id, type }
EncryptedCodeExecutionResultBlock = object { content, encrypted_stdout, return_code, 2 more } Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
content: array of CodeExecutionOutputBlock { file_id, type }
BashCodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: BashCodeExecutionToolResultError { error_code, type } or BashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
BashCodeExecutionToolResultError = object { error_code, type }
error_code: BashCodeExecutionToolResultErrorCode
BashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
content: array of BashCodeExecutionOutputBlock { file_id, type }
TextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: TextEditorCodeExecutionToolResultError { error_code, error_message, type } or TextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } or TextEditorCodeExecutionCreateResultBlock { is_file_update, type } or TextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
TextEditorCodeExecutionToolResultError = object { error_code, error_message, type }
error_code: TextEditorCodeExecutionToolResultErrorCode
TextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }
file_type: "text" or "image" or "pdf"
TextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }
TextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }
ToolSearchToolResultBlock = object { content, tool_use_id, type }
content: ToolSearchToolResultError { error_code, error_message, type } or ToolSearchToolSearchResultBlock { tool_references, type }
ToolSearchToolResultError = object { error_code, error_message, type }
error_code: ToolSearchToolResultErrorCode
ToolSearchToolSearchResultBlock = object { tool_references, type }
tool_references: array of ToolReferenceBlock { tool_name, type }
ContainerUploadBlock = object { file_id, type } Response model for a file uploaded to the container.
Response model for a file uploaded to the container.
model: ModelThe model that will complete your prompt.
The model that will complete your prompt.
See models for additional details and options.
UnionMember0 = "claude-opus-4-6" or "claude-sonnet-4-6" or "claude-haiku-4-5" or 12 moreThe model that will complete your prompt.
The model that will complete your prompt.
See models for additional details and options.
Most intelligent model for building agents and coding
Best combination of speed and intelligence
Fastest model with near-frontier intelligence
Fastest model with near-frontier intelligence
Premium model combining maximum intelligence with practical performance
Premium model combining maximum intelligence with practical performance
High-performance model for agents and coding
High-performance model for agents and coding
Exceptional model for specialized complex tasks
Exceptional model for specialized complex tasks
Powerful model for complex tasks
Powerful model for complex tasks
High-performance model with extended thinking
High-performance model with extended thinking
Fast and cost-effective model
role: "assistant"Conversational role of the generated message.
Conversational role of the generated message.
This will always be "assistant".
stop_reason: StopReasonThe reason that we stopped.
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: stringWhich custom stop sequence was generated, if any.
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.
Object type.
For Messages, this is always "message".
usage: Usage { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 5 more } Billing and rate-limit usage.
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: CacheCreation { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens } Breakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The geographic region where inference was performed for this request.
The number of input tokens which were used.
The number of output tokens which were used.
server_tool_use: ServerToolUsage { web_fetch_requests, web_search_requests } The number of server tool requests.
The number of server tool requests.
The number of web fetch tool requests.
The number of web search tool requests.
service_tier: "standard" or "priority" or "batch"If the request used the priority, standard, or batch tier.
If the request used the priority, standard, or batch tier.
RawMessageStreamEvent = RawMessageStartEvent { message, type } or RawMessageDeltaEvent { delta, type, usage } or RawMessageStopEvent { type } or 3 more
RawMessageStartEvent = object { message, type }
message: Message { id, container, content, 6 more }
id: stringUnique object identifier.
Unique object identifier.
The format and length of IDs may change over time.
container: Container { id, expires_at } Information about the container used in the request (for the code execution tool)
Information about the container used in the request (for the code execution tool)
Identifier for the container used in this request
The time at which the container will expire.
content: array of ContentBlockContent generated by the model.
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)"}]
TextBlock = object { citations, text, type }
citations: array of TextCitationCitations supporting the text block.
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.
CitationCharLocation = object { cited_text, document_index, document_title, 4 more }
CitationPageLocation = object { cited_text, document_index, document_title, 4 more }
CitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
CitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
CitationsSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
ThinkingBlock = object { signature, thinking, type }
RedactedThinkingBlock = object { data, type }
ToolUseBlock = object { id, caller, input, 2 more }
caller: DirectCaller { type } or ServerToolCaller { tool_id, type } or ServerToolCaller20260120 { tool_id, type } Tool invocation directly from the model.
Tool invocation directly from the model.
DirectCaller = object { type } Tool invocation directly from the model.
Tool invocation directly from the model.
ServerToolCaller = object { tool_id, type } Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
ServerToolCaller20260120 = object { tool_id, type }
ServerToolUseBlock = object { id, caller, input, 2 more }
caller: DirectCaller { type } or ServerToolCaller { tool_id, type } or ServerToolCaller20260120 { tool_id, type } Tool invocation directly from the model.
Tool invocation directly from the model.
DirectCaller = object { type } Tool invocation directly from the model.
Tool invocation directly from the model.
ServerToolCaller = object { tool_id, type } Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
ServerToolCaller20260120 = object { tool_id, type }
name: "web_search" or "web_fetch" or "code_execution" or 4 more
WebSearchToolResultBlock = object { caller, content, tool_use_id, type }
caller: DirectCaller { type } or ServerToolCaller { tool_id, type } or ServerToolCaller20260120 { tool_id, type } Tool invocation directly from the model.
Tool invocation directly from the model.
DirectCaller = object { type } Tool invocation directly from the model.
Tool invocation directly from the model.
ServerToolCaller = object { tool_id, type } Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
ServerToolCaller20260120 = object { tool_id, type }
content: WebSearchToolResultBlockContent
WebSearchToolResultError = object { error_code, type }
error_code: WebSearchToolResultErrorCode
UnionMember1 = array of WebSearchResultBlock { encrypted_content, page_age, title, 2 more }
WebFetchToolResultBlock = object { caller, content, tool_use_id, type }
caller: DirectCaller { type } or ServerToolCaller { tool_id, type } or ServerToolCaller20260120 { tool_id, type } Tool invocation directly from the model.
Tool invocation directly from the model.
DirectCaller = object { type } Tool invocation directly from the model.
Tool invocation directly from the model.
ServerToolCaller = object { tool_id, type } Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
ServerToolCaller20260120 = object { tool_id, type }
content: WebFetchToolResultErrorBlock { error_code, type } or WebFetchBlock { content, retrieved_at, type, url }
WebFetchToolResultErrorBlock = object { error_code, type }
error_code: WebFetchToolResultErrorCode
WebFetchBlock = object { content, retrieved_at, type, url }
content: DocumentBlock { citations, source, title, type }
citations: CitationsConfig { enabled } Citation configuration for the document
Citation configuration for the document
source: Base64PDFSource { data, media_type, type } or PlainTextSource { data, media_type, type }
Base64PDFSource = object { data, media_type, type }
PlainTextSource = object { data, media_type, type }
The title of the document
ISO 8601 timestamp when the content was retrieved
Fetched content URL
CodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: CodeExecutionToolResultBlockContentCode execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
CodeExecutionToolResultError = object { error_code, type }
error_code: CodeExecutionToolResultErrorCode
CodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
content: array of CodeExecutionOutputBlock { file_id, type }
EncryptedCodeExecutionResultBlock = object { content, encrypted_stdout, return_code, 2 more } Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
content: array of CodeExecutionOutputBlock { file_id, type }
BashCodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: BashCodeExecutionToolResultError { error_code, type } or BashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
BashCodeExecutionToolResultError = object { error_code, type }
error_code: BashCodeExecutionToolResultErrorCode
BashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
content: array of BashCodeExecutionOutputBlock { file_id, type }
TextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: TextEditorCodeExecutionToolResultError { error_code, error_message, type } or TextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } or TextEditorCodeExecutionCreateResultBlock { is_file_update, type } or TextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
TextEditorCodeExecutionToolResultError = object { error_code, error_message, type }
error_code: TextEditorCodeExecutionToolResultErrorCode
TextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }
file_type: "text" or "image" or "pdf"
TextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }
TextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }
ToolSearchToolResultBlock = object { content, tool_use_id, type }
content: ToolSearchToolResultError { error_code, error_message, type } or ToolSearchToolSearchResultBlock { tool_references, type }
ToolSearchToolResultError = object { error_code, error_message, type }
error_code: ToolSearchToolResultErrorCode
ToolSearchToolSearchResultBlock = object { tool_references, type }
tool_references: array of ToolReferenceBlock { tool_name, type }
ContainerUploadBlock = object { file_id, type } Response model for a file uploaded to the container.
Response model for a file uploaded to the container.
model: ModelThe model that will complete your prompt.
The model that will complete your prompt.
See models for additional details and options.
UnionMember0 = "claude-opus-4-6" or "claude-sonnet-4-6" or "claude-haiku-4-5" or 12 moreThe model that will complete your prompt.
The model that will complete your prompt.
See models for additional details and options.
Most intelligent model for building agents and coding
Best combination of speed and intelligence
Fastest model with near-frontier intelligence
Fastest model with near-frontier intelligence
Premium model combining maximum intelligence with practical performance
Premium model combining maximum intelligence with practical performance
High-performance model for agents and coding
High-performance model for agents and coding
Exceptional model for specialized complex tasks
Exceptional model for specialized complex tasks
Powerful model for complex tasks
Powerful model for complex tasks
High-performance model with extended thinking
High-performance model with extended thinking
Fast and cost-effective model
role: "assistant"Conversational role of the generated message.
Conversational role of the generated message.
This will always be "assistant".
stop_reason: StopReasonThe reason that we stopped.
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: stringWhich custom stop sequence was generated, if any.
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.
Object type.
For Messages, this is always "message".
usage: Usage { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 5 more } Billing and rate-limit usage.
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: CacheCreation { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens } Breakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The geographic region where inference was performed for this request.
The number of input tokens which were used.
The number of output tokens which were used.
server_tool_use: ServerToolUsage { web_fetch_requests, web_search_requests } The number of server tool requests.
The number of server tool requests.
The number of web fetch tool requests.
The number of web search tool requests.
service_tier: "standard" or "priority" or "batch"If the request used the priority, standard, or batch tier.
If the request used the priority, standard, or batch tier.
RawMessageDeltaEvent = object { delta, type, usage }
delta: object { container, stop_reason, stop_sequence }
container: Container { id, expires_at } Information about the container used in the request (for the code execution tool)
Information about the container used in the request (for the code execution tool)
Identifier for the container used in this request
The time at which the container will expire.
stop_reason: StopReason
usage: MessageDeltaUsage { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more } Billing and rate-limit usage.
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.
The cumulative number of input tokens used to create the cache entry.
The cumulative number of input tokens read from the cache.
The cumulative number of input tokens which were used.
The cumulative number of output tokens which were used.
server_tool_use: ServerToolUsage { web_fetch_requests, web_search_requests } The number of server tool requests.
The number of server tool requests.
The number of web fetch tool requests.
The number of web search tool requests.
RawMessageStopEvent = object { type }
RawContentBlockStartEvent = object { content_block, index, type }
content_block: TextBlock { citations, text, type } or ThinkingBlock { signature, thinking, type } or RedactedThinkingBlock { data, type } or 9 moreResponse model for a file uploaded to the container.
Response model for a file uploaded to the container.
TextBlock = object { citations, text, type }
citations: array of TextCitationCitations supporting the text block.
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.
CitationCharLocation = object { cited_text, document_index, document_title, 4 more }
CitationPageLocation = object { cited_text, document_index, document_title, 4 more }
CitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
CitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
CitationsSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
ThinkingBlock = object { signature, thinking, type }
RedactedThinkingBlock = object { data, type }
ToolUseBlock = object { id, caller, input, 2 more }
caller: DirectCaller { type } or ServerToolCaller { tool_id, type } or ServerToolCaller20260120 { tool_id, type } Tool invocation directly from the model.
Tool invocation directly from the model.
DirectCaller = object { type } Tool invocation directly from the model.
Tool invocation directly from the model.
ServerToolCaller = object { tool_id, type } Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
ServerToolCaller20260120 = object { tool_id, type }
ServerToolUseBlock = object { id, caller, input, 2 more }
caller: DirectCaller { type } or ServerToolCaller { tool_id, type } or ServerToolCaller20260120 { tool_id, type } Tool invocation directly from the model.
Tool invocation directly from the model.
DirectCaller = object { type } Tool invocation directly from the model.
Tool invocation directly from the model.
ServerToolCaller = object { tool_id, type } Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
ServerToolCaller20260120 = object { tool_id, type }
name: "web_search" or "web_fetch" or "code_execution" or 4 more
WebSearchToolResultBlock = object { caller, content, tool_use_id, type }
caller: DirectCaller { type } or ServerToolCaller { tool_id, type } or ServerToolCaller20260120 { tool_id, type } Tool invocation directly from the model.
Tool invocation directly from the model.
DirectCaller = object { type } Tool invocation directly from the model.
Tool invocation directly from the model.
ServerToolCaller = object { tool_id, type } Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
ServerToolCaller20260120 = object { tool_id, type }
content: WebSearchToolResultBlockContent
WebSearchToolResultError = object { error_code, type }
error_code: WebSearchToolResultErrorCode
UnionMember1 = array of WebSearchResultBlock { encrypted_content, page_age, title, 2 more }
WebFetchToolResultBlock = object { caller, content, tool_use_id, type }
caller: DirectCaller { type } or ServerToolCaller { tool_id, type } or ServerToolCaller20260120 { tool_id, type } Tool invocation directly from the model.
Tool invocation directly from the model.
DirectCaller = object { type } Tool invocation directly from the model.
Tool invocation directly from the model.
ServerToolCaller = object { tool_id, type } Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
ServerToolCaller20260120 = object { tool_id, type }
content: WebFetchToolResultErrorBlock { error_code, type } or WebFetchBlock { content, retrieved_at, type, url }
WebFetchToolResultErrorBlock = object { error_code, type }
error_code: WebFetchToolResultErrorCode
WebFetchBlock = object { content, retrieved_at, type, url }
content: DocumentBlock { citations, source, title, type }
citations: CitationsConfig { enabled } Citation configuration for the document
Citation configuration for the document
source: Base64PDFSource { data, media_type, type } or PlainTextSource { data, media_type, type }
Base64PDFSource = object { data, media_type, type }
PlainTextSource = object { data, media_type, type }
The title of the document
ISO 8601 timestamp when the content was retrieved
Fetched content URL
CodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: CodeExecutionToolResultBlockContentCode execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
CodeExecutionToolResultError = object { error_code, type }
error_code: CodeExecutionToolResultErrorCode
CodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
content: array of CodeExecutionOutputBlock { file_id, type }
EncryptedCodeExecutionResultBlock = object { content, encrypted_stdout, return_code, 2 more } Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
content: array of CodeExecutionOutputBlock { file_id, type }
BashCodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: BashCodeExecutionToolResultError { error_code, type } or BashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
BashCodeExecutionToolResultError = object { error_code, type }
error_code: BashCodeExecutionToolResultErrorCode
BashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
content: array of BashCodeExecutionOutputBlock { file_id, type }
TextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: TextEditorCodeExecutionToolResultError { error_code, error_message, type } or TextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } or TextEditorCodeExecutionCreateResultBlock { is_file_update, type } or TextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
TextEditorCodeExecutionToolResultError = object { error_code, error_message, type }
error_code: TextEditorCodeExecutionToolResultErrorCode
TextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }
file_type: "text" or "image" or "pdf"
TextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }
TextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }
ToolSearchToolResultBlock = object { content, tool_use_id, type }
content: ToolSearchToolResultError { error_code, error_message, type } or ToolSearchToolSearchResultBlock { tool_references, type }
ToolSearchToolResultError = object { error_code, error_message, type }
error_code: ToolSearchToolResultErrorCode
ToolSearchToolSearchResultBlock = object { tool_references, type }
tool_references: array of ToolReferenceBlock { tool_name, type }
ContainerUploadBlock = object { file_id, type } Response model for a file uploaded to the container.
Response model for a file uploaded to the container.
RawContentBlockDeltaEvent = object { delta, index, type }
delta: RawContentBlockDelta
TextDelta = object { text, type }
InputJSONDelta = object { partial_json, type }
CitationsDelta = object { citation, type }
citation: CitationCharLocation { cited_text, document_index, document_title, 4 more } or CitationPageLocation { cited_text, document_index, document_title, 4 more } or CitationContentBlockLocation { cited_text, document_index, document_title, 4 more } or 2 more
CitationCharLocation = object { cited_text, document_index, document_title, 4 more }
CitationPageLocation = object { cited_text, document_index, document_title, 4 more }
CitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
CitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
CitationsSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
ThinkingDelta = object { thinking, type }
SignatureDelta = object { signature, type }
RawContentBlockStopEvent = object { index, type }
curl https://api.anthropic.com/v1/messages \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
--max-time 600 \
-d '{
"max_tokens": 1024,
"messages": [
{
"content": "Hello, world",
"role": "user"
}
],
"model": "claude-opus-4-6"
}'{
"id": "msg_013Zva2CMHLNnXjNJJKqJ2EF",
"container": {
"id": "id",
"expires_at": "2019-12-27T18:11:19.117Z"
},
"content": [
{
"citations": [
{
"cited_text": "cited_text",
"document_index": 0,
"document_title": "document_title",
"end_char_index": 0,
"file_id": "file_id",
"start_char_index": 0,
"type": "char_location"
}
],
"text": "Hi! My name is Claude.",
"type": "text"
}
],
"model": "claude-opus-4-6",
"role": "assistant",
"stop_reason": "end_turn",
"stop_sequence": null,
"type": "message",
"usage": {
"cache_creation": {
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
},
"cache_creation_input_tokens": 2051,
"cache_read_input_tokens": 2051,
"inference_geo": "inference_geo",
"input_tokens": 2095,
"output_tokens": 503,
"server_tool_use": {
"web_fetch_requests": 2,
"web_search_requests": 0
},
"service_tier": "standard"
}
}Returns Examples
{
"id": "msg_013Zva2CMHLNnXjNJJKqJ2EF",
"container": {
"id": "id",
"expires_at": "2019-12-27T18:11:19.117Z"
},
"content": [
{
"citations": [
{
"cited_text": "cited_text",
"document_index": 0,
"document_title": "document_title",
"end_char_index": 0,
"file_id": "file_id",
"start_char_index": 0,
"type": "char_location"
}
],
"text": "Hi! My name is Claude.",
"type": "text"
}
],
"model": "claude-opus-4-6",
"role": "assistant",
"stop_reason": "end_turn",
"stop_sequence": null,
"type": "message",
"usage": {
"cache_creation": {
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
},
"cache_creation_input_tokens": 2051,
"cache_read_input_tokens": 2051,
"inference_geo": "inference_geo",
"input_tokens": 2095,
"output_tokens": 503,
"server_tool_use": {
"web_fetch_requests": 2,
"web_search_requests": 0
},
"service_tier": "standard"
}
}