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
Body ParametersExpand Collapse
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.
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.
TextBlockParam = object { text, type, cache_control, citations }
type: "text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
CitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
type: "char_location"
CitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
type: "page_location"
CitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
type: "content_block_location"
CitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
type: "web_search_result_location"
CitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
type: "search_result_location"
ImageBlockParam = object { source, type, cache_control }
Base64ImageSource = object { data, media_type, type }
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
type: "base64"
URLImageSource = object { type, url }
type: "url"
type: "image"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
DocumentBlockParam = object { source, type, cache_control, 3 more }
source: Base64PDFSource { data, media_type, type } or PlainTextSource { data, media_type, type } or ContentBlockSource { content, type } or URLPDFSource { type, url }
Base64PDFSource = object { data, media_type, type }
media_type: "application/pdf"
type: "base64"
PlainTextSource = object { data, media_type, type }
media_type: "text/plain"
type: "text"
ContentBlockSource = object { content, type }
TextBlockParam = object { text, type, cache_control, citations }
type: "text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
CitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
type: "char_location"
CitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
type: "page_location"
CitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
type: "content_block_location"
CitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
type: "web_search_result_location"
CitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
type: "search_result_location"
ImageBlockParam = object { source, type, cache_control }
Base64ImageSource = object { data, media_type, type }
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
type: "base64"
URLImageSource = object { type, url }
type: "url"
type: "image"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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"
URLPDFSource = object { type, url }
type: "url"
type: "document"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
SearchResultBlockParam = object { content, source, title, 3 more }
type: "text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
CitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
type: "char_location"
CitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
type: "page_location"
CitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
type: "content_block_location"
CitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
type: "web_search_result_location"
CitationSearchResultLocationParam = object { 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.
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
ThinkingBlockParam = object { signature, thinking, type }
type: "thinking"
RedactedThinkingBlockParam = object { data, type }
type: "redacted_thinking"
ToolUseBlockParam = object { id, input, name, 2 more }
type: "tool_use"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
ToolResultBlockParam = object { tool_use_id, type, cache_control, 2 more }
type: "tool_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
content: optional string or array of TextBlockParam { text, type, cache_control, citations } or ImageBlockParam { source, type, cache_control } or SearchResultBlockParam { content, source, title, 3 more } or DocumentBlockParam { source, type, cache_control, 3 more }
UnionMember1 = array of TextBlockParam { text, type, cache_control, citations } or ImageBlockParam { source, type, cache_control } or SearchResultBlockParam { content, source, title, 3 more } or DocumentBlockParam { source, type, cache_control, 3 more }
TextBlockParam = object { text, type, cache_control, citations }
type: "text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
CitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
type: "char_location"
CitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
type: "page_location"
CitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
type: "content_block_location"
CitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
type: "web_search_result_location"
CitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
type: "search_result_location"
ImageBlockParam = object { source, type, cache_control }
Base64ImageSource = object { data, media_type, type }
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
type: "base64"
URLImageSource = object { type, url }
type: "url"
type: "image"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
SearchResultBlockParam = object { content, source, title, 3 more }
type: "text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
CitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
type: "char_location"
CitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
type: "page_location"
CitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
type: "content_block_location"
CitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
type: "web_search_result_location"
CitationSearchResultLocationParam = object { 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.
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
DocumentBlockParam = object { source, type, cache_control, 3 more }
source: Base64PDFSource { data, media_type, type } or PlainTextSource { data, media_type, type } or ContentBlockSource { content, type } or URLPDFSource { type, url }
Base64PDFSource = object { data, media_type, type }
media_type: "application/pdf"
type: "base64"
PlainTextSource = object { data, media_type, type }
media_type: "text/plain"
type: "text"
ContentBlockSource = object { content, type }
TextBlockParam = object { text, type, cache_control, citations }
type: "text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
CitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
type: "char_location"
CitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
type: "page_location"
CitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
type: "content_block_location"
CitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
type: "web_search_result_location"
CitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
type: "search_result_location"
ImageBlockParam = object { source, type, cache_control }
Base64ImageSource = object { data, media_type, type }
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
type: "base64"
URLImageSource = object { type, url }
type: "url"
type: "image"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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"
URLPDFSource = object { type, url }
type: "url"
type: "document"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
ServerToolUseBlockParam = object { id, input, name, 2 more }
name: "web_search"
type: "server_tool_use"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
WebSearchToolResultBlockParam = object { content, tool_use_id, type, cache_control }
WebSearchToolResultBlockItem = array of WebSearchResultBlockParam { encrypted_content, title, type, 2 more }
type: "web_search_result"
WebSearchToolRequestError = object { error_code, type }
error_code: "invalid_tool_input" or "unavailable" or "max_uses_exceeded" or 2 more
type: "web_search_tool_result_error"
type: "web_search_tool_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
role: "user" or "assistant"
UnionMember0 = "claude-3-7-sonnet-latest" or "claude-3-7-sonnet-20250219" or "claude-3-5-haiku-latest" or 15 moreThe model that will complete your prompt.
See models for additional details and options.
The model that will complete your prompt.
See models for additional details and options.
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
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.
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.
type: "text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
CitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
type: "char_location"
CitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
type: "page_location"
CitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
type: "content_block_location"
CitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
type: "web_search_result_location"
CitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
type: "search_result_location"
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.
Configuration for enabling Claude's extended thinking.
When enabled, responses include thinking content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your max_tokens limit.
See extended thinking for details.
ThinkingConfigEnabled = object { budget_tokens, type }
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"
ThinkingConfigDisabled = object { type }
type: "disabled"
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.
How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all.
ToolChoiceAuto = object { type, disable_parallel_tool_use } The model will automatically decide whether to use tools.
The model will automatically decide whether to use tools.
type: "auto"
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output at most one tool use.
ToolChoiceAny = object { type, disable_parallel_tool_use } The model will use any available tools.
The model will use any available tools.
type: "any"
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
ToolChoiceTool = object { name, type, disable_parallel_tool_use } The model will use the specified tool with tool_choice.name.
The model will use the specified tool with tool_choice.name.
The name of the tool to use.
type: "tool"
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
ToolChoiceNone = object { type } The model will not be allowed to use tools.
The model will not be allowed to use tools.
type: "none"
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 tool input shape that the model will produce in tool_use output 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.
Definitions of tools that the model may use.
If you include tools in your API request, the model may return tool_use content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using tool_result content blocks.
There are two types of tools: client tools and server tools. The behavior described below applies to client tools. For server tools, see their individual documentation as each has its own behavior (e.g., the web search tool).
Each tool definition includes:
name: Name of the tool.description: Optional, but strongly-recommended description of the tool.input_schema: JSON schema for the toolinputshape that the model will produce intool_useoutput content blocks.
For example, if you defined tools as:
[
{
"name": "get_stock_price",
"description": "Get the current stock price for a given ticker symbol.",
"input_schema": {
"type": "object",
"properties": {
"ticker": {
"type": "string",
"description": "The stock ticker symbol, e.g. AAPL for Apple Inc."
}
},
"required": ["ticker"]
}
}
]
And then asked the model "What's the S&P 500 at today?", the model might produce tool_use content blocks in the response like this:
[
{
"type": "tool_use",
"id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
"name": "get_stock_price",
"input": { "ticker": "^GSPC" }
}
]
You might then run your get_stock_price tool with {"ticker": "^GSPC"} as an input, and return the following back to the model in a subsequent user message:
[
{
"type": "tool_result",
"tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
"content": "259.75 USD"
}
]
Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output.
See our guide for more details.
Tool = object { input_schema, name, cache_control, 2 more }
input_schema: object { 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.
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 of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
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: optional "custom"
ToolBash20250124 = object { name, type, cache_control }
name: "bash"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: "bash_20250124"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
ToolTextEditor20250124 = object { name, type, cache_control }
name: "str_replace_editor"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: "text_editor_20250124"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
ToolTextEditor20250429 = object { name, type, cache_control }
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.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: "text_editor_20250429"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
ToolTextEditor20250728 = object { name, type, cache_control, max_characters }
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.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: "text_editor_20250728"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.
WebSearchTool20250305 = object { name, type, allowed_domains, 4 more }
name: "web_search"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: "web_search_20250305"
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.
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
ttl: optional "5m" or "1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Maximum number of times the tool can be used in the API request.
user_location: optional object { type, city, country, 2 more } Parameters for the user's location. Used to provide more relevant search results.
Parameters for the user's location. Used to provide more relevant search results.
type: "approximate"
The city of the user.
The region of the user.
ReturnsExpand Collapse
MessageTokensCount = object { input_tokens }
The total number of tokens across the provided list of messages, system prompt, and tools.
Count tokens in a Message
curl https://api.anthropic.com/v1/messages/count_tokens \
-H 'Content-Type: application/json' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"messages": [
{
"content": "string",
"role": "user"
}
],
"model": "claude-3-7-sonnet-latest"
}'{
"input_tokens": 2095
}Returns Examples
{
"input_tokens": 2095
}