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
ParametersExpand Collapse
MessageCreateParams = MessageCreateParamsNonStreaming { stream } | MessageCreateParamsStreaming { stream }
MessageCreateParamsBase { max_tokens, messages, model, 17 more }
max_tokens: number
Body param: The maximum number of tokens to generate before stopping.
Note that our models may stop before reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate.
Different models have different maximum values for this parameter. See models for details.
Body param: Input messages.
Our models are trained to operate on alternating user and assistant conversational turns. When creating a new Message, you specify the prior conversational turns with the messages parameter, and the model then generates the next Message in the conversation. Consecutive user or assistant turns in your request will be combined into a single turn.
Each input message must be an object with a role and content. You can specify a single user-role message, or you can include multiple user and assistant messages.
If the final message uses the assistant role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response.
Example with a single user message:
[{"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.
Array<BetaContentBlockParam>
BetaTextBlockParam { text, type, cache_control, citations }
type: "text"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: "char_location"
BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: "page_location"
BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: "content_block_location"
BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: "web_search_result_location"
BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: "search_result_location"
BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
BetaBase64ImageSource { data, media_type, type }
media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"
type: "base64"
BetaURLImageSource { type, url }
type: "url"
BetaFileImageSource { file_id, type }
type: "file"
type: "image"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaRequestDocumentBlock { source, type, cache_control, 3 more }
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type } | BetaContentBlockSource { content, type } | 2 more
BetaBase64PDFSource { data, media_type, type }
media_type: "application/pdf"
type: "base64"
BetaPlainTextSource { data, media_type, type }
media_type: "text/plain"
type: "text"
BetaContentBlockSource { content, type }
BetaTextBlockParam { text, type, cache_control, citations }
type: "text"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: "char_location"
BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: "page_location"
BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: "content_block_location"
BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: "web_search_result_location"
BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: "search_result_location"
BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
BetaBase64ImageSource { data, media_type, type }
media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"
type: "base64"
BetaURLImageSource { type, url }
type: "url"
BetaFileImageSource { file_id, type }
type: "file"
type: "image"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: "content"
BetaURLPDFSource { type, url }
type: "url"
BetaFileDocumentSource { file_id, type }
type: "file"
type: "document"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaSearchResultBlockParam { content, source, title, 3 more }
type: "text"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: "char_location"
BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: "page_location"
BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: "content_block_location"
BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: "web_search_result_location"
BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: "search_result_location"
type: "search_result"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaThinkingBlockParam { signature, thinking, type }
type: "thinking"
BetaRedactedThinkingBlockParam { data, type }
type: "redacted_thinking"
BetaToolUseBlockParam { id, input, name, 3 more }
type: "tool_use"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Tool invocation directly from the model.
BetaDirectCaller { type }
Tool invocation directly from the model.
type: "direct"
BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: "code_execution_20250825"
BetaToolResultBlockParam { tool_use_id, type, cache_control, 2 more }
type: "tool_result"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
content?: string | Array<BetaTextBlockParam { text, type, cache_control, citations } | BetaImageBlockParam { source, type, cache_control } | BetaSearchResultBlockParam { content, source, title, 3 more } | 2 more>
Array<BetaTextBlockParam { text, type, cache_control, citations } | BetaImageBlockParam { source, type, cache_control } | BetaSearchResultBlockParam { content, source, title, 3 more } | 2 more>
BetaTextBlockParam { text, type, cache_control, citations }
type: "text"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: "char_location"
BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: "page_location"
BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: "content_block_location"
BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: "web_search_result_location"
BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: "search_result_location"
BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
BetaBase64ImageSource { data, media_type, type }
media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"
type: "base64"
BetaURLImageSource { type, url }
type: "url"
BetaFileImageSource { file_id, type }
type: "file"
type: "image"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaSearchResultBlockParam { content, source, title, 3 more }
type: "text"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: "char_location"
BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: "page_location"
BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: "content_block_location"
BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: "web_search_result_location"
BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: "search_result_location"
type: "search_result"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaRequestDocumentBlock { source, type, cache_control, 3 more }
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type } | BetaContentBlockSource { content, type } | 2 more
BetaBase64PDFSource { data, media_type, type }
media_type: "application/pdf"
type: "base64"
BetaPlainTextSource { data, media_type, type }
media_type: "text/plain"
type: "text"
BetaContentBlockSource { content, type }
BetaTextBlockParam { text, type, cache_control, citations }
type: "text"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: "char_location"
BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: "page_location"
BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: "content_block_location"
BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: "web_search_result_location"
BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: "search_result_location"
BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
BetaBase64ImageSource { data, media_type, type }
media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"
type: "base64"
BetaURLImageSource { type, url }
type: "url"
BetaFileImageSource { file_id, type }
type: "file"
type: "image"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: "content"
BetaURLPDFSource { type, url }
type: "url"
BetaFileDocumentSource { file_id, type }
type: "file"
type: "document"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaToolReferenceBlockParam { tool_name, type, cache_control }
Tool reference block that can be included in tool_result content.
type: "tool_reference"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaServerToolUseBlockParam { id, input, name, 3 more }
name: "web_search" | "web_fetch" | "code_execution" | 4 more
type: "server_tool_use"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Tool invocation directly from the model.
BetaDirectCaller { type }
Tool invocation directly from the model.
type: "direct"
BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: "code_execution_20250825"
BetaWebSearchToolResultBlockParam { content, tool_use_id, type, cache_control }
Array<BetaWebSearchResultBlockParam { encrypted_content, title, type, 2 more } >
type: "web_search_result"
BetaWebSearchToolRequestError { error_code, type }
type: "web_search_tool_result_error"
type: "web_search_tool_result"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaWebFetchToolResultBlockParam { content, tool_use_id, type, cache_control }
content: BetaWebFetchToolResultErrorBlockParam { error_code, type } | BetaWebFetchBlockParam { content, type, url, retrieved_at }
BetaWebFetchToolResultErrorBlockParam { error_code, type }
type: "web_fetch_tool_result_error"
BetaWebFetchBlockParam { content, type, url, retrieved_at }
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type } | BetaContentBlockSource { content, type } | 2 more
BetaBase64PDFSource { data, media_type, type }
media_type: "application/pdf"
type: "base64"
BetaPlainTextSource { data, media_type, type }
media_type: "text/plain"
type: "text"
BetaContentBlockSource { content, type }
BetaTextBlockParam { text, type, cache_control, citations }
type: "text"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: "char_location"
BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: "page_location"
BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: "content_block_location"
BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: "web_search_result_location"
BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: "search_result_location"
BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
BetaBase64ImageSource { data, media_type, type }
media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"
type: "base64"
BetaURLImageSource { type, url }
type: "url"
BetaFileImageSource { file_id, type }
type: "file"
type: "image"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: "content"
BetaURLPDFSource { type, url }
type: "url"
BetaFileDocumentSource { file_id, type }
type: "file"
type: "document"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: "web_fetch_result"
url: string
Fetched content URL
retrieved_at?: string | null
ISO 8601 timestamp when the content was retrieved
type: "web_fetch_tool_result"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }
BetaCodeExecutionToolResultErrorParam { error_code, type }
type: "code_execution_tool_result_error"
BetaCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
type: "code_execution_output"
type: "code_execution_result"
type: "code_execution_tool_result"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaBashCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }
content: BetaBashCodeExecutionToolResultErrorParam { error_code, type } | BetaBashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
BetaBashCodeExecutionToolResultErrorParam { error_code, type }
error_code: "invalid_tool_input" | "unavailable" | "too_many_requests" | 2 more
type: "bash_code_execution_tool_result_error"
BetaBashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
type: "bash_code_execution_output"
type: "bash_code_execution_result"
type: "bash_code_execution_tool_result"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaTextEditorCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }
content: BetaTextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message } | BetaTextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more } | BetaTextEditorCodeExecutionCreateResultBlockParam { is_file_update, type } | BetaTextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }
BetaTextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message }
error_code: "invalid_tool_input" | "unavailable" | "too_many_requests" | 2 more
type: "text_editor_code_execution_tool_result_error"
BetaTextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more }
file_type: "text" | "image" | "pdf"
type: "text_editor_code_execution_view_result"
BetaTextEditorCodeExecutionCreateResultBlockParam { is_file_update, type }
type: "text_editor_code_execution_create_result"
BetaTextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }
type: "text_editor_code_execution_str_replace_result"
type: "text_editor_code_execution_tool_result"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaToolSearchToolResultBlockParam { content, tool_use_id, type, cache_control }
content: BetaToolSearchToolResultErrorParam { error_code, type } | BetaToolSearchToolSearchResultBlockParam { tool_references, type }
BetaToolSearchToolResultErrorParam { error_code, type }
error_code: "invalid_tool_input" | "unavailable" | "too_many_requests" | "execution_time_exceeded"
type: "tool_search_tool_result_error"
BetaToolSearchToolSearchResultBlockParam { tool_references, type }
type: "tool_reference"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: "tool_search_tool_search_result"
type: "tool_search_tool_result"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaMCPToolUseBlockParam { id, input, name, 3 more }
server_name: string
The name of the MCP server
type: "mcp_tool_use"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaRequestMCPToolResultBlockParam { tool_use_id, type, cache_control, 2 more }
type: "mcp_tool_result"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Array<BetaTextBlockParam { text, type, cache_control, citations } >
type: "text"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: "char_location"
BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: "page_location"
BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: "content_block_location"
BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: "web_search_result_location"
BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: "search_result_location"
BetaContainerUploadBlockParam { file_id, type, cache_control }
A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory.
type: "container_upload"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
role: "user" | "assistant"
Body param: The model that will complete your prompt.
See models for additional details and options.
"claude-opus-4-5-20251101" | "claude-opus-4-5" | "claude-3-7-sonnet-latest" | 17 more
"claude-opus-4-5-20251101"
Premium model combining maximum intelligence with practical performance
"claude-opus-4-5"
Premium model combining maximum intelligence with practical performance
"claude-3-7-sonnet-latest"
High-performance model with early extended thinking
"claude-3-7-sonnet-20250219"
High-performance model with early extended thinking
"claude-3-5-haiku-latest"
Fastest and most compact model for near-instant responsiveness
"claude-3-5-haiku-20241022"
Our fastest model
"claude-haiku-4-5"
Hybrid model, capable of near-instant responses and extended thinking
"claude-haiku-4-5-20251001"
Hybrid model, capable of near-instant responses and extended thinking
"claude-sonnet-4-20250514"
High-performance model with extended thinking
"claude-sonnet-4-0"
High-performance model with extended thinking
"claude-4-sonnet-20250514"
High-performance model with extended thinking
"claude-sonnet-4-5"
Our best model for real-world agents and coding
"claude-sonnet-4-5-20250929"
Our best model for real-world agents and coding
"claude-opus-4-0"
Our most capable model
"claude-opus-4-20250514"
Our most capable model
"claude-4-opus-20250514"
Our most capable model
"claude-opus-4-1-20250805"
Our most capable model
"claude-3-opus-latest"
Excels at writing and complex tasks
"claude-3-opus-20240229"
Excels at writing and complex tasks
"claude-3-haiku-20240307"
Our previous most fast and cost-effective
Body param: Container identifier for reuse across requests.
BetaContainerParams { id, skills }
Container parameters with skills to be loaded.
id?: string | null
Container id
List of skills to load in the container
skill_id: string
Skill ID
type: "anthropic" | "custom"
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
version?: string
Skill version or 'latest' for most recent version
Body param: Context management configuration.
This allows you to control how Claude manages context across multiple requests, such as whether to clear function results or not.
edits?: Array<BetaClearToolUses20250919Edit { type, clear_at_least, clear_tool_inputs, 3 more } | BetaClearThinking20251015Edit { type, keep } >
List of context management edits to apply
BetaClearToolUses20250919Edit { type, clear_at_least, clear_tool_inputs, 3 more }
type: "clear_tool_uses_20250919"
Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed.
type: "input_tokens"
clear_tool_inputs?: boolean | Array<string> | null
Whether to clear all tool inputs (bool) or specific tool inputs to clear (list)
exclude_tools?: Array<string> | null
Tool names whose uses are preserved from clearing
Number of tool uses to retain in the conversation
type: "tool_uses"
Condition that triggers the context management strategy
BetaInputTokensTrigger { type, value }
type: "input_tokens"
BetaToolUsesTrigger { type, value }
type: "tool_uses"
BetaClearThinking20251015Edit { type, keep }
type: "clear_thinking_20251015"
Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed.
BetaThinkingTurns { type, value }
type: "thinking_turns"
BetaAllThinkingTurns { type }
type: "all"
"all"
Body param: MCP servers to be utilized in this request
type: "url"
Body param: An object describing metadata about the request.
user_id?: string | null
An external identifier for the user who is associated with the request.
This should be a uuid, hash value, or other opaque identifier. Anthropic may use this id to help detect abuse. Do not include any identifying information such as name, email address, or phone number.
Body param: Configuration options for the model's output. Controls aspects like how much effort the model puts into its response.
effort?: "low" | "medium" | "high" | null
All possible effort levels.
Body param: A schema to specify Claude's output format in responses.
schema: Record<string, unknown>
The JSON schema of the format
type: "json_schema"
service_tier?: "auto" | "standard_only"
Body param: Determines whether to use priority capacity (if available) or standard capacity for this request.
Anthropic offers different levels of service for your API requests. See service-tiers for details.
stop_sequences?: Array<string>
Body param: Custom text sequences that will cause the model to stop generating.
Our models will normally stop when they have naturally completed their turn, which will result in a response stop_reason of "end_turn".
If you want the model to stop generating when it encounters custom strings of text, you can use the stop_sequences parameter. If the model encounters one of the custom sequences, the response stop_reason value will be "stop_sequence" and the response stop_sequence value will contain the matched stop sequence.
stream?: false
Body param: Whether to incrementally stream the response using server-sent events.
See streaming for details.
Body param: System prompt.
A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our guide to system prompts.
Array<BetaTextBlockParam { text, type, cache_control, citations } >
type: "text"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
type: "char_location"
BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: "page_location"
BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: "content_block_location"
BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: "web_search_result_location"
BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: "search_result_location"
temperature?: number
Body param: Amount of randomness injected into the response.
Defaults to 1.0. Ranges from 0.0 to 1.0. Use temperature closer to 0.0 for analytical / multiple choice, and closer to 1.0 for creative and generative tasks.
Note that even with temperature of 0.0, the results will not be fully deterministic.
Body param: Configuration for enabling Claude's extended thinking.
When enabled, responses include thinking content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your max_tokens limit.
See extended thinking for details.
BetaThinkingConfigEnabled { budget_tokens, type }
budget_tokens: number
Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality.
Must be ≥1024 and less than max_tokens.
See extended thinking for details.
type: "enabled"
BetaThinkingConfigDisabled { type }
type: "disabled"
Body param: How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all.
BetaToolChoiceAuto { type, disable_parallel_tool_use }
The model will automatically decide whether to use tools.
type: "auto"
disable_parallel_tool_use?: boolean
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output at most one tool use.
BetaToolChoiceAny { type, disable_parallel_tool_use }
The model will use any available tools.
type: "any"
disable_parallel_tool_use?: boolean
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
BetaToolChoiceTool { name, type, disable_parallel_tool_use }
The model will use the specified tool with tool_choice.name.
name: string
The name of the tool to use.
type: "tool"
disable_parallel_tool_use?: boolean
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
BetaToolChoiceNone { type }
The model will not be allowed to use tools.
type: "none"
Body param: Definitions of tools that the model may use.
If you include tools in your API request, the model may return tool_use content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using tool_result content blocks.
There are two types of tools: client tools and server tools. The behavior described below applies to client tools. For server tools, 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.
BetaTool { input_schema, name, allowed_callers, 6 more }
input_schema: InputSchema { type, properties, required }
JSON schema for this tool's input.
This defines the shape of the input that your tool accepts and that the model will produce.
type: "object"
name: string
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers?: Array<"direct" | "code_execution_20250825">
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading?: boolean
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
description?: string
Description of what this tool does.
Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema.
type?: "custom" | null
BetaToolBash20241022 { name, type, allowed_callers, 4 more }
name: "bash"
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: "bash_20241022"
allowed_callers?: Array<"direct" | "code_execution_20250825">
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading?: boolean
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
BetaToolBash20250124 { name, type, allowed_callers, 4 more }
name: "bash"
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: "bash_20250124"
allowed_callers?: Array<"direct" | "code_execution_20250825">
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading?: boolean
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
BetaCodeExecutionTool20250522 { name, type, allowed_callers, 3 more }
name: "code_execution"
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: "code_execution_20250522"
allowed_callers?: Array<"direct" | "code_execution_20250825">
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading?: boolean
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
BetaCodeExecutionTool20250825 { name, type, allowed_callers, 3 more }
name: "code_execution"
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: "code_execution_20250825"
allowed_callers?: Array<"direct" | "code_execution_20250825">
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading?: boolean
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
BetaToolComputerUse20241022 { display_height_px, display_width_px, name, 7 more }
display_height_px: number
The height of the display in pixels.
display_width_px: number
The width of the display in pixels.
name: "computer"
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: "computer_20241022"
allowed_callers?: Array<"direct" | "code_execution_20250825">
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading?: boolean
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
display_number?: number | null
The X11 display number (e.g. 0, 1) for the display.
BetaMemoryTool20250818 { name, type, allowed_callers, 4 more }
name: "memory"
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: "memory_20250818"
allowed_callers?: Array<"direct" | "code_execution_20250825">
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading?: boolean
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
BetaToolComputerUse20250124 { display_height_px, display_width_px, name, 7 more }
display_height_px: number
The height of the display in pixels.
display_width_px: number
The width of the display in pixels.
name: "computer"
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: "computer_20250124"
allowed_callers?: Array<"direct" | "code_execution_20250825">
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading?: boolean
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
display_number?: number | null
The X11 display number (e.g. 0, 1) for the display.
BetaToolTextEditor20241022 { name, type, allowed_callers, 4 more }
name: "str_replace_editor"
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: "text_editor_20241022"
allowed_callers?: Array<"direct" | "code_execution_20250825">
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading?: boolean
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
BetaToolComputerUse20251124 { display_height_px, display_width_px, name, 8 more }
display_height_px: number
The height of the display in pixels.
display_width_px: number
The width of the display in pixels.
name: "computer"
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: "computer_20251124"
allowed_callers?: Array<"direct" | "code_execution_20250825">
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading?: boolean
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
display_number?: number | null
The X11 display number (e.g. 0, 1) for the display.
enable_zoom?: boolean
Whether to enable an action to take a zoomed-in screenshot of the screen.
BetaToolTextEditor20250124 { name, type, allowed_callers, 4 more }
name: "str_replace_editor"
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: "text_editor_20250124"
allowed_callers?: Array<"direct" | "code_execution_20250825">
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading?: boolean
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
BetaToolTextEditor20250429 { name, type, allowed_callers, 4 more }
name: "str_replace_based_edit_tool"
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: "text_editor_20250429"
allowed_callers?: Array<"direct" | "code_execution_20250825">
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading?: boolean
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
BetaToolTextEditor20250728 { name, type, allowed_callers, 5 more }
name: "str_replace_based_edit_tool"
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: "text_editor_20250728"
allowed_callers?: Array<"direct" | "code_execution_20250825">
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading?: boolean
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
max_characters?: number | null
Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.
BetaWebSearchTool20250305 { name, type, allowed_callers, 7 more }
name: "web_search"
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: "web_search_20250305"
allowed_callers?: Array<"direct" | "code_execution_20250825">
allowed_domains?: Array<string> | null
If provided, only these domains will be included in results. Cannot be used alongside blocked_domains.
blocked_domains?: Array<string> | null
If provided, these domains will never appear in results. Cannot be used alongside allowed_domains.
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading?: boolean
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
max_uses?: number | null
Maximum number of times the tool can be used in the API request.
user_location?: UserLocation | null
Parameters for the user's location. Used to provide more relevant search results.
type: "approximate"
city?: string | null
The city of the user.
country?: string | null
The two letter ISO country code of the user.
region?: string | null
The region of the user.
timezone?: string | null
The IANA timezone of the user.
BetaWebFetchTool20250910 { name, type, allowed_callers, 8 more }
name: "web_fetch"
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: "web_fetch_20250910"
allowed_callers?: Array<"direct" | "code_execution_20250825">
allowed_domains?: Array<string> | null
List of domains to allow fetching from
blocked_domains?: Array<string> | null
List of domains to block fetching from
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Citations configuration for fetched documents. Citations are disabled by default.
defer_loading?: boolean
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
max_content_tokens?: number | null
Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
max_uses?: number | null
Maximum number of times the tool can be used in the API request.
BetaToolSearchToolBm25_20251119 { name, type, allowed_callers, 3 more }
name: "tool_search_tool_bm25"
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: "tool_search_tool_bm25_20251119" | "tool_search_tool_bm25"
allowed_callers?: Array<"direct" | "code_execution_20250825">
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading?: boolean
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
BetaToolSearchToolRegex20251119 { name, type, allowed_callers, 3 more }
name: "tool_search_tool_regex"
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: "tool_search_tool_regex_20251119" | "tool_search_tool_regex"
allowed_callers?: Array<"direct" | "code_execution_20250825">
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
defer_loading?: boolean
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
BetaMCPToolset { mcp_server_name, type, cache_control, 2 more }
Configuration for a group of tools from an MCP server.
Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides.
mcp_server_name: string
Name of the MCP server to configure tools for
type: "mcp_toolset"
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl?: "5m" | "1h"
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Configuration overrides for specific tools, keyed by tool name
Default configuration applied to all tools from this server
top_k?: number
Body param: Only sample from the top K options for each subsequent token.
Used to remove "long tail" low probability responses. Learn more technical details here.
Recommended for advanced use cases only. You usually only need to use temperature.
top_p?: number
Body param: Use nucleus sampling.
In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by top_p. You should either alter temperature or top_p, but not both.
Recommended for advanced use cases only. You usually only need to use temperature.
Header param: Optional header to specify the beta version(s) you want to use.
"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 16 more
MessageCreateParamsNonStreaming extends MessageCreateParamsBase { max_tokens, messages, model, 17 more } { stream }
stream?: false
Body param: Whether to incrementally stream the response using server-sent events.
See streaming for details.
MessageCreateParamsNonStreaming extends MessageCreateParamsBase { max_tokens, messages, model, 17 more } { stream }
stream?: false
Body param: Whether to incrementally stream the response using server-sent events.
See streaming for details.
ReturnsExpand Collapse
BetaMessage { id, container, content, 7 more }
id: string
Unique object identifier.
The format and length of IDs may change over time.
Information about the container used in the request (for the code execution tool)
id: string
Identifier for the container used in this request
expires_at: string
The time at which the container will expire.
Skills loaded in the container
skill_id: string
Skill ID
type: "anthropic" | "custom"
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
version: string
Skill version or 'latest' for most recent version
Content generated by the model.
This is an array of content blocks, each of which has a type that determines its shape.
Example:
[{"type": "text", "text": "Hi, I'm Claude."}]
If the request input messages ended with an assistant turn, then the response content will continue directly from that last turn. You can use this to constrain the model's output.
For example, if the input messages were:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("}
]
Then the response content might be:
[{"type": "text", "text": "B)"}]
BetaTextBlock { citations, text, type }
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: "char_location"
BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: "page_location"
BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: "content_block_location"
BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: "web_search_result_location"
BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: "search_result_location"
type: "text"
BetaThinkingBlock { signature, thinking, type }
type: "thinking"
BetaRedactedThinkingBlock { data, type }
type: "redacted_thinking"
BetaToolUseBlock { id, input, name, 2 more }
type: "tool_use"
Tool invocation directly from the model.
BetaDirectCaller { type }
Tool invocation directly from the model.
type: "direct"
BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: "code_execution_20250825"
BetaServerToolUseBlock { id, caller, input, 2 more }
Tool invocation directly from the model.
BetaDirectCaller { type }
Tool invocation directly from the model.
type: "direct"
BetaServerToolCaller { tool_id, type }
Tool invocation generated by a server-side tool.
type: "code_execution_20250825"
name: "web_search" | "web_fetch" | "code_execution" | 4 more
type: "server_tool_use"
BetaWebSearchToolResultBlock { content, tool_use_id, type }
BetaWebSearchToolResultError { error_code, type }
type: "web_search_tool_result_error"
Array<BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more } >
type: "web_search_result"
type: "web_search_tool_result"
BetaWebFetchToolResultBlock { content, tool_use_id, type }
content: BetaWebFetchToolResultErrorBlock { error_code, type } | BetaWebFetchBlock { content, retrieved_at, type, url }
BetaWebFetchToolResultErrorBlock { error_code, type }
type: "web_fetch_tool_result_error"
BetaWebFetchBlock { content, retrieved_at, type, url }
Citation configuration for the document
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type }
BetaBase64PDFSource { data, media_type, type }
media_type: "application/pdf"
type: "base64"
BetaPlainTextSource { data, media_type, type }
media_type: "text/plain"
type: "text"
title: string | null
The title of the document
type: "document"
retrieved_at: string | null
ISO 8601 timestamp when the content was retrieved
type: "web_fetch_result"
url: string
Fetched content URL
type: "web_fetch_tool_result"
BetaCodeExecutionToolResultBlock { content, tool_use_id, type }
BetaCodeExecutionToolResultError { error_code, type }
type: "code_execution_tool_result_error"
BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }
type: "code_execution_output"
type: "code_execution_result"
type: "code_execution_tool_result"
BetaBashCodeExecutionToolResultBlock { content, tool_use_id, type }
content: BetaBashCodeExecutionToolResultError { error_code, type } | BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
BetaBashCodeExecutionToolResultError { error_code, type }
error_code: "invalid_tool_input" | "unavailable" | "too_many_requests" | 2 more
type: "bash_code_execution_tool_result_error"
BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
type: "bash_code_execution_output"
type: "bash_code_execution_result"
type: "bash_code_execution_tool_result"
BetaTextEditorCodeExecutionToolResultBlock { content, tool_use_id, type }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } | BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } | BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } | BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type }
error_code: "invalid_tool_input" | "unavailable" | "too_many_requests" | 2 more
type: "text_editor_code_execution_tool_result_error"
BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more }
file_type: "text" | "image" | "pdf"
type: "text_editor_code_execution_view_result"
BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type }
type: "text_editor_code_execution_create_result"
BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
type: "text_editor_code_execution_str_replace_result"
type: "text_editor_code_execution_tool_result"
BetaToolSearchToolResultBlock { content, tool_use_id, type }
content: BetaToolSearchToolResultError { error_code, error_message, type } | BetaToolSearchToolSearchResultBlock { tool_references, type }
BetaToolSearchToolResultError { error_code, error_message, type }
error_code: "invalid_tool_input" | "unavailable" | "too_many_requests" | "execution_time_exceeded"
type: "tool_search_tool_result_error"
BetaToolSearchToolSearchResultBlock { tool_references, type }
type: "tool_reference"
type: "tool_search_tool_search_result"
type: "tool_search_tool_result"
BetaMCPToolUseBlock { id, input, name, 2 more }
name: string
The name of the MCP tool
server_name: string
The name of the MCP server
type: "mcp_tool_use"
BetaMCPToolResultBlock { content, is_error, tool_use_id, type }
Array<BetaTextBlock { citations, text, type } >
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }
type: "char_location"
BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }
type: "page_location"
BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
type: "content_block_location"
BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
type: "web_search_result_location"
BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
type: "search_result_location"
type: "text"
type: "mcp_tool_result"
BetaContainerUploadBlock { file_id, type }
Response model for a file uploaded to the container.
type: "container_upload"
Context management response.
Information about context management strategies applied during the request.
applied_edits: Array<BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } | BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type } >
List of context management edits that were applied.
BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type }
cleared_input_tokens: number
Number of input tokens cleared by this edit.
cleared_tool_uses: number
Number of tool uses that were cleared.
type: "clear_tool_uses_20250919"
The type of context management edit applied.
BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }
cleared_input_tokens: number
Number of input tokens cleared by this edit.
cleared_thinking_turns: number
Number of thinking turns that were cleared.
type: "clear_thinking_20251015"
The type of context management edit applied.
The model that will complete your prompt.
See models for additional details and options.
"claude-opus-4-5-20251101" | "claude-opus-4-5" | "claude-3-7-sonnet-latest" | 17 more
"claude-opus-4-5-20251101"
Premium model combining maximum intelligence with practical performance
"claude-opus-4-5"
Premium model combining maximum intelligence with practical performance
"claude-3-7-sonnet-latest"
High-performance model with early extended thinking
"claude-3-7-sonnet-20250219"
High-performance model with early extended thinking
"claude-3-5-haiku-latest"
Fastest and most compact model for near-instant responsiveness
"claude-3-5-haiku-20241022"
Our fastest model
"claude-haiku-4-5"
Hybrid model, capable of near-instant responses and extended thinking
"claude-haiku-4-5-20251001"
Hybrid model, capable of near-instant responses and extended thinking
"claude-sonnet-4-20250514"
High-performance model with extended thinking
"claude-sonnet-4-0"
High-performance model with extended thinking
"claude-4-sonnet-20250514"
High-performance model with extended thinking
"claude-sonnet-4-5"
Our best model for real-world agents and coding
"claude-sonnet-4-5-20250929"
Our best model for real-world agents and coding
"claude-opus-4-0"
Our most capable model
"claude-opus-4-20250514"
Our most capable model
"claude-4-opus-20250514"
Our most capable model
"claude-opus-4-1-20250805"
Our most capable model
"claude-3-opus-latest"
Excels at writing and complex tasks
"claude-3-opus-20240229"
Excels at writing and complex tasks
"claude-3-haiku-20240307"
Our previous most fast and cost-effective
role: "assistant"
Conversational role of the generated message.
This will always be "assistant".
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
stop_sequence: string | null
Which custom stop sequence was generated, if any.
This value will be a non-null string if one of your custom stop sequences was generated.
type: "message"
Object type.
For Messages, this is always "message".
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
Breakdown of cached tokens by TTL
ephemeral_1h_input_tokens: number
The number of input tokens used to create the 1 hour cache entry.
ephemeral_5m_input_tokens: number
The number of input tokens used to create the 5 minute cache entry.
cache_creation_input_tokens: number | null
The number of input tokens used to create the cache entry.
cache_read_input_tokens: number | null
The number of input tokens read from the cache.
input_tokens: number
The number of input tokens which were used.
output_tokens: number
The number of output tokens which were used.
The number of server tool requests.
web_fetch_requests: number
The number of web fetch tool requests.
web_search_requests: number
The number of web search tool requests.
service_tier: "standard" | "priority" | "batch" | null
If the request used the priority, standard, or batch tier.
import Anthropic from '@anthropic-ai/sdk';
const client = new Anthropic({
apiKey: process.env['ANTHROPIC_API_KEY'], // This is the default and can be omitted
});
const betaMessage = await client.beta.messages.create({
max_tokens: 1024,
messages: [{ content: 'Hello, world', role: 'user' }],
model: 'claude-sonnet-4-5-20250929',
});
console.log(betaMessage.id);{
"id": "msg_013Zva2CMHLNnXjNJJKqJ2EF",
"container": {
"id": "id",
"expires_at": "2019-12-27T18:11:19.117Z",
"skills": [
{
"skill_id": "x",
"type": "anthropic",
"version": "x"
}
]
},
"content": [
{
"citations": [
{
"cited_text": "cited_text",
"document_index": 0,
"document_title": "document_title",
"end_char_index": 0,
"file_id": "file_id",
"start_char_index": 0,
"type": "char_location"
}
],
"text": "Hi! My name is Claude.",
"type": "text"
}
],
"context_management": {
"applied_edits": [
{
"cleared_input_tokens": 0,
"cleared_tool_uses": 0,
"type": "clear_tool_uses_20250919"
}
]
},
"model": "claude-sonnet-4-5-20250929",
"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,
"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",
"skills": [
{
"skill_id": "x",
"type": "anthropic",
"version": "x"
}
]
},
"content": [
{
"citations": [
{
"cited_text": "cited_text",
"document_index": 0,
"document_title": "document_title",
"end_char_index": 0,
"file_id": "file_id",
"start_char_index": 0,
"type": "char_location"
}
],
"text": "Hi! My name is Claude.",
"type": "text"
}
],
"context_management": {
"applied_edits": [
{
"cleared_input_tokens": 0,
"cleared_tool_uses": 0,
"type": "clear_tool_uses_20250919"
}
]
},
"model": "claude-sonnet-4-5-20250929",
"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,
"input_tokens": 2095,
"output_tokens": 503,
"server_tool_use": {
"web_fetch_requests": 2,
"web_search_requests": 0
},
"service_tier": "standard"
}
}