Count tokens in a Message
Count the number of tokens in a Message.
The Token Count API can be used to count the number of tokens in a Message, including tools, images, and documents, without creating it.
Learn more about token counting in our user guide
ParametersExpand Collapse
params: MessageCountTokensParams { messages, model, cache_control, 10 more }
messages: Array<BetaMessageParam { content, role } >Body param: Input messages.
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.
content: string | Array<BetaContentBlockParam>
Array<BetaContentBlockParam>
BetaTextBlockParam { text, type, cache_control, citations }
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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?: Array<BetaTextCitationParam> | null
BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
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"
BetaURLImageSource { type, url }
BetaFileImageSource { file_id, type }
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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.
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 }
BetaPlainTextSource { data, media_type, type }
BetaContentBlockSource { content, type }
content: string | Array<BetaContentBlockSourceContent>
BetaTextBlockParam { text, type, cache_control, citations }
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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?: Array<BetaTextCitationParam> | null
BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
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"
BetaURLImageSource { type, url }
BetaFileImageSource { file_id, type }
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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.
BetaURLPDFSource { type, url }
BetaFileDocumentSource { file_id, type }
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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?: BetaCitationsConfigParam { enabled } | null
BetaSearchResultBlockParam { content, source, title, 3 more }
content: Array<BetaTextBlockParam { text, type, cache_control, citations } >
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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?: Array<BetaTextCitationParam> | null
BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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?: BetaCitationsConfigParam { enabled }
BetaThinkingBlockParam { signature, thinking, type }
BetaRedactedThinkingBlockParam { data, type }
BetaToolUseBlockParam { id, input, name, 3 more }
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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?: BetaDirectCaller { type } | BetaServerToolCaller { tool_id, type } | BetaServerToolCaller20260120 { tool_id, type } Tool invocation directly from the model.
Tool invocation directly from the model.
BetaDirectCaller { type } Tool invocation directly from the model.
Tool invocation directly from the model.
BetaServerToolCaller { tool_id, type } Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
BetaServerToolCaller20260120 { tool_id, type }
BetaToolResultBlockParam { tool_use_id, type, cache_control, 2 more }
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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?: 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 }
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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?: Array<BetaTextCitationParam> | null
BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
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"
BetaURLImageSource { type, url }
BetaFileImageSource { file_id, type }
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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.
BetaSearchResultBlockParam { content, source, title, 3 more }
content: Array<BetaTextBlockParam { text, type, cache_control, citations } >
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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?: Array<BetaTextCitationParam> | null
BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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?: BetaCitationsConfigParam { enabled }
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 }
BetaPlainTextSource { data, media_type, type }
BetaContentBlockSource { content, type }
content: string | Array<BetaContentBlockSourceContent>
BetaTextBlockParam { text, type, cache_control, citations }
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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?: Array<BetaTextCitationParam> | null
BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
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"
BetaURLImageSource { type, url }
BetaFileImageSource { file_id, type }
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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.
BetaURLPDFSource { type, url }
BetaFileDocumentSource { file_id, type }
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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?: BetaCitationsConfigParam { enabled } | null
BetaToolReferenceBlockParam { 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?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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.
BetaServerToolUseBlockParam { id, input, name, 3 more }
name: "web_search" | "web_fetch" | "code_execution" | 4 more
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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?: BetaDirectCaller { type } | BetaServerToolCaller { tool_id, type } | BetaServerToolCaller20260120 { tool_id, type } Tool invocation directly from the model.
Tool invocation directly from the model.
BetaDirectCaller { type } Tool invocation directly from the model.
Tool invocation directly from the model.
BetaServerToolCaller { tool_id, type } Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
BetaServerToolCaller20260120 { tool_id, type }
BetaWebSearchToolResultBlockParam { content, tool_use_id, type, 2 more }
Array<BetaWebSearchResultBlockParam { encrypted_content, title, type, 2 more } >
BetaWebSearchToolRequestError { error_code, type }
error_code: BetaWebSearchToolResultErrorCode
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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?: BetaDirectCaller { type } | BetaServerToolCaller { tool_id, type } | BetaServerToolCaller20260120 { tool_id, type } Tool invocation directly from the model.
Tool invocation directly from the model.
BetaDirectCaller { type } Tool invocation directly from the model.
Tool invocation directly from the model.
BetaServerToolCaller { tool_id, type } Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
BetaServerToolCaller20260120 { tool_id, type }
BetaWebFetchToolResultBlockParam { content, tool_use_id, type, 2 more }
content: BetaWebFetchToolResultErrorBlockParam { error_code, type } | BetaWebFetchBlockParam { content, type, url, retrieved_at }
BetaWebFetchToolResultErrorBlockParam { error_code, type }
error_code: BetaWebFetchToolResultErrorCode
BetaWebFetchBlockParam { content, type, url, retrieved_at }
content: 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 }
BetaPlainTextSource { data, media_type, type }
BetaContentBlockSource { content, type }
content: string | Array<BetaContentBlockSourceContent>
BetaTextBlockParam { text, type, cache_control, citations }
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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?: Array<BetaTextCitationParam> | null
BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
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"
BetaURLImageSource { type, url }
BetaFileImageSource { file_id, type }
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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.
BetaURLPDFSource { type, url }
BetaFileDocumentSource { file_id, type }
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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?: BetaCitationsConfigParam { enabled } | null
Fetched content URL
ISO 8601 timestamp when the content was retrieved
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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?: BetaDirectCaller { type } | BetaServerToolCaller { tool_id, type } | BetaServerToolCaller20260120 { tool_id, type } Tool invocation directly from the model.
Tool invocation directly from the model.
BetaDirectCaller { type } Tool invocation directly from the model.
Tool invocation directly from the model.
BetaServerToolCaller { tool_id, type } Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
BetaServerToolCaller20260120 { tool_id, type }
BetaCodeExecutionToolResultBlockParam { 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.
BetaCodeExecutionToolResultErrorParam { error_code, type }
error_code: BetaCodeExecutionToolResultErrorCode
BetaCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
content: Array<BetaCodeExecutionOutputBlockParam { file_id, type } >
BetaEncryptedCodeExecutionResultBlockParam { 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<BetaCodeExecutionOutputBlockParam { file_id, type } >
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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.
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
BetaBashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
content: Array<BetaBashCodeExecutionOutputBlockParam { file_id, type } >
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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.
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
BetaTextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more }
file_type: "text" | "image" | "pdf"
BetaTextEditorCodeExecutionCreateResultBlockParam { is_file_update, type }
BetaTextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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.
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"
BetaToolSearchToolSearchResultBlockParam { tool_references, type }
tool_references: Array<BetaToolReferenceBlockParam { tool_name, type, cache_control } >
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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.
BetaMCPToolUseBlockParam { id, input, name, 3 more }
The name of the MCP server
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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.
BetaRequestMCPToolResultBlockParam { tool_use_id, type, cache_control, 2 more }
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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?: string | Array<BetaTextBlockParam { text, type, cache_control, citations } >
Array<BetaTextBlockParam { text, type, cache_control, citations } >
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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?: Array<BetaTextCitationParam> | null
BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
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.
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?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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.
BetaCompactionBlockParam { content, type, cache_control } A compaction block containing summary of previous context.
A compaction block containing summary of previous context.
Users should round-trip these blocks from responses to subsequent requests to maintain context across compaction boundaries.
When content is None, the block represents a failed compaction. The server treats these as no-ops. Empty string content is not allowed.
Summary of previously compacted content, or null if compaction failed
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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" | "assistant"
model: ModelBody param: The model that will complete your prompt.
Body param: The model that will complete your prompt.
See models for additional details and options.
"claude-opus-4-6" | "claude-sonnet-4-6" | "claude-opus-4-5-20251101" | 19 more
Most intelligent model for building agents and coding
Frontier intelligence at scale — built for coding, agents, and enterprise workflows
Premium model combining maximum intelligence with practical performance
Premium model combining maximum intelligence with practical performance
High-performance model with early extended thinking
High-performance model with early extended thinking
Fastest and most compact model for near-instant responsiveness
Our fastest model
Hybrid model, capable of near-instant responses and extended thinking
Hybrid model, capable of near-instant responses and extended thinking
High-performance model with extended thinking
High-performance model with extended thinking
High-performance model with extended thinking
Our best model for real-world agents and coding
Our best model for real-world agents and coding
Our most capable model
Our most capable model
Our most capable model
Our most capable model
Excels at writing and complex tasks
Excels at writing and complex tasks
Our previous most fast and cost-effective
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullBody param: Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request.
Body param: Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request.
ttl?: "5m" | "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.
context_management?: BetaContextManagementConfig { edits } | nullBody param: Context management configuration.
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 } | BetaCompact20260112Edit { type, instructions, pause_after_compaction, trigger } >List of context management edits to apply
List of context management edits to apply
BetaClearToolUses20250919Edit { type, clear_at_least, clear_tool_inputs, 3 more }
clear_at_least?: BetaInputTokensClearAtLeast { type, value } | nullMinimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed.
Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed.
clear_tool_inputs?: boolean | Array<string> | nullWhether to clear all tool inputs (bool) or specific tool inputs to clear (list)
Whether to clear all tool inputs (bool) or specific tool inputs to clear (list)
Tool names whose uses are preserved from clearing
keep?: BetaToolUsesKeep { type, value } Number of tool uses to retain in the conversation
Number of tool uses to retain in the conversation
trigger?: BetaInputTokensTrigger { type, value } | BetaToolUsesTrigger { type, value } Condition that triggers the context management strategy
Condition that triggers the context management strategy
BetaInputTokensTrigger { type, value }
BetaToolUsesTrigger { type, value }
BetaClearThinking20251015Edit { type, keep }
keep?: BetaThinkingTurns { type, value } | BetaAllThinkingTurns { type } | "all"Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed.
Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed.
BetaThinkingTurns { type, value }
BetaAllThinkingTurns { type }
"all"
BetaCompact20260112Edit { type, instructions, pause_after_compaction, trigger } Automatically compact older context when reaching the configured trigger threshold.
Automatically compact older context when reaching the configured trigger threshold.
Additional instructions for summarization.
Whether to pause after compaction and return the compaction block to the user.
trigger?: BetaInputTokensTrigger { type, value } | nullWhen to trigger compaction. Defaults to 150000 input tokens.
When to trigger compaction. Defaults to 150000 input tokens.
mcp_servers?: Array<BetaRequestMCPServerURLDefinition { name, type, url, 2 more } >Body param: MCP servers to be utilized in this request
Body param: MCP servers to be utilized in this request
tool_configuration?: BetaRequestMCPServerToolConfiguration { allowed_tools, enabled } | null
output_config?: BetaOutputConfig { effort, format } Body param: Configuration options for the model's output, such as the output format.
Body param: Configuration options for the model's output, such as the output format.
effort?: "low" | "medium" | "high" | "max" | nullAll possible effort levels.
All possible effort levels.
format?: BetaJSONOutputFormat { schema, type } | nullA 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
Deprecatedoutput_format?: BetaJSONOutputFormat { schema, type } | nullBody param: Deprecated: Use output_config.format instead. See structured outputs
Body param: Deprecated: Use output_config.format instead. See structured outputs
A schema to specify Claude's output format in responses. This parameter will be removed in a future release.
The JSON schema of the format
speed?: "standard" | "fast" | nullBody param: The inference speed mode for this request. "fast" enables high output-tokens-per-second inference.
Body param: The inference speed mode for this request. "fast" enables high output-tokens-per-second inference.
system?: string | Array<BetaTextBlockParam { text, type, cache_control, citations } >Body param: System prompt.
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 } >
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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?: Array<BetaTextCitationParam> | null
BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
thinking?: BetaThinkingConfigParamBody param: Configuration for enabling Claude's extended thinking.
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: 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.
BetaThinkingConfigDisabled { type }
BetaThinkingConfigAdaptive { type }
tool_choice?: BetaToolChoiceBody 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.
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.
The model will automatically decide whether to use tools.
disable_parallel_tool_use?: 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.
BetaToolChoiceAny { type, disable_parallel_tool_use } The model will use any available tools.
The model will use any available tools.
disable_parallel_tool_use?: 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.
BetaToolChoiceTool { 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?: 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.
BetaToolChoiceNone { type } The model will not be allowed to use tools.
The model will not be allowed to use tools.
tools?: Array<BetaTool { input_schema, name, allowed_callers, 7 more } | BetaToolBash20241022 { name, type, allowed_callers, 4 more } | BetaToolBash20250124 { name, type, allowed_callers, 4 more } | 18 more>Body param: Definitions of tools that the model may use.
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, 7 more }
input_schema: InputSchema { 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?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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?: 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
BetaToolBash20241022 { 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?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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
BetaToolBash20250124 { 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?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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
BetaCodeExecutionTool20250522 { 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?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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
BetaCodeExecutionTool20250825 { 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?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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
BetaCodeExecutionTool20260120 { 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?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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
BetaToolComputerUse20241022 { display_height_px, display_width_px, name, 7 more }
The height of the display in pixels.
The width of the display in pixels.
name: "computer"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?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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.
The X11 display number (e.g. 0, 1) for the display.
When true, guarantees schema validation on tool names and inputs
BetaMemoryTool20250818 { 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?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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
BetaToolComputerUse20250124 { display_height_px, display_width_px, name, 7 more }
The height of the display in pixels.
The width of the display in pixels.
name: "computer"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?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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.
The X11 display number (e.g. 0, 1) for the display.
When true, guarantees schema validation on tool names and inputs
BetaToolTextEditor20241022 { 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?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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
BetaToolComputerUse20251124 { display_height_px, display_width_px, name, 8 more }
The height of the display in pixels.
The width of the display in pixels.
name: "computer"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?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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.
The X11 display number (e.g. 0, 1) for the display.
Whether to enable an action to take a zoomed-in screenshot of the screen.
When true, guarantees schema validation on tool names and inputs
BetaToolTextEditor20250124 { 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?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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
BetaToolTextEditor20250429 { 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?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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
BetaToolTextEditor20250728 { 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?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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
BetaWebSearchTool20250305 { 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?: Array<"direct" | "code_execution_20250825" | "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?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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?: BetaUserLocation { type, city, country, 2 more } | nullParameters 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.
BetaWebFetchTool20250910 { 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?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
List of domains to allow fetching from
List of domains to block fetching from
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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?: BetaCitationsConfigParam { enabled } | nullCitations 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
BetaWebSearchTool20260209 { 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?: Array<"direct" | "code_execution_20250825" | "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?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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?: BetaUserLocation { type, city, country, 2 more } | nullParameters 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.
BetaWebFetchTool20260209 { 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?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
List of domains to allow fetching from
List of domains to block fetching from
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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?: BetaCitationsConfigParam { enabled } | nullCitations 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
BetaToolSearchToolBm25_20251119 { 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" | "tool_search_tool_bm25"
allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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
BetaToolSearchToolRegex20251119 { 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" | "tool_search_tool_regex"
allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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
BetaMCPToolset { mcp_server_name, type, cache_control, 2 more } Configuration for a group of tools from an MCP server.
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.
Name of the MCP server to configure tools for
cache_control?: BetaCacheControlEphemeral { type, ttl } | nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl?: "5m" | "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.
configs?: Record<string, BetaMCPToolConfig { defer_loading, enabled } > | nullConfiguration overrides for specific tools, keyed by tool name
Configuration overrides for specific tools, keyed by tool name
default_config?: BetaMCPToolDefaultConfig { defer_loading, enabled } Default configuration applied to all tools from this server
Default configuration applied to all tools from this server
betas?: Array<AnthropicBeta>Header param: Optional header to specify the beta version(s) you want to use.
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" | 17 more
ReturnsExpand Collapse
BetaMessageTokensCount { context_management, input_tokens }
context_management: BetaCountTokensContextManagementResponse { original_input_tokens } | nullInformation about context management applied to the message.
Information about context management applied to the message.
The original token count before context management was applied
The total number of tokens across the provided list of messages, system prompt, and tools.
import Anthropic from '@anthropic-ai/sdk';
const client = new Anthropic({
apiKey: process.env['ANTHROPIC_API_KEY'], // This is the default and can be omitted
});
const betaMessageTokensCount = await client.beta.messages.countTokens({
messages: [{ content: 'string', role: 'user' }],
model: 'claude-opus-4-6',
});
console.log(betaMessageTokensCount.context_management);{
"context_management": {
"original_input_tokens": 0
},
"input_tokens": 2095
}Returns Examples
{
"context_management": {
"original_input_tokens": 0
},
"input_tokens": 2095
}