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
MessageCountTokensParams params
List<MessageParam> messagesInput messages.
Input messages.
Our models are trained to operate on alternating user and assistant conversational turns. When creating a new Message, you specify the prior conversational turns with the messages parameter, and the model then generates the next Message in the conversation. Consecutive user or assistant turns in your request will be combined into a single turn.
Each input message must be an object with a role and content. You can specify a single user-role message, or you can include multiple user and assistant messages.
If the final message uses the assistant role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response.
Example with a single user message:
[{"role": "user", "content": "Hello, Claude"}]
Example with multiple conversational turns:
[
{"role": "user", "content": "Hello there."},
{"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"},
{"role": "user", "content": "Can you explain LLMs in plain English?"},
]
Example with a partially-filled response from Claude:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("},
]
Each input message content may be either a single string or an array of content blocks, where each block has a specific type. Using a string for content is shorthand for an array of one content block of type "text". The following input messages are equivalent:
{"role": "user", "content": "Hello, Claude"}
{"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]}
See input examples.
Note that if you want to include a system prompt, you can use the top-level system parameter — there is no "system" role for input messages in the Messages API.
There is a limit of 100,000 messages in a single request.
Content content
List<ContentBlockParam>
class TextBlockParam:
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
Optional<List<TextCitationParam>> citations
class CitationCharLocationParam:
class CitationPageLocationParam:
class CitationContentBlockLocationParam:
class CitationWebSearchResultLocationParam:
class CitationSearchResultLocationParam:
class ImageBlockParam:
Source source
class Base64ImageSource:
MediaType mediaType
class UrlImageSource:
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
class DocumentBlockParam:
Source source
class Base64PdfSource:
class PlainTextSource:
class ContentBlockSource:
Content content
class TextBlockParam:
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
Optional<List<TextCitationParam>> citations
class CitationCharLocationParam:
class CitationPageLocationParam:
class CitationContentBlockLocationParam:
class CitationWebSearchResultLocationParam:
class CitationSearchResultLocationParam:
class ImageBlockParam:
Source source
class Base64ImageSource:
MediaType mediaType
class UrlImageSource:
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
class UrlPdfSource:
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
Optional<CitationsConfigParam> citations
class SearchResultBlockParam:
List<TextBlockParam> content
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
Optional<List<TextCitationParam>> citations
class CitationCharLocationParam:
class CitationPageLocationParam:
class CitationContentBlockLocationParam:
class CitationWebSearchResultLocationParam:
class CitationSearchResultLocationParam:
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
Optional<CitationsConfigParam> citations
class ThinkingBlockParam:
class RedactedThinkingBlockParam:
class ToolUseBlockParam:
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
Optional<Caller> callerTool invocation directly from the model.
Tool invocation directly from the model.
class DirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class ServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class ServerToolCaller20260120:
class ToolResultBlockParam:
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
Optional<Content> content
List<Block>
class TextBlockParam:
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
Optional<List<TextCitationParam>> citations
class CitationCharLocationParam:
class CitationPageLocationParam:
class CitationContentBlockLocationParam:
class CitationWebSearchResultLocationParam:
class CitationSearchResultLocationParam:
class ImageBlockParam:
Source source
class Base64ImageSource:
MediaType mediaType
class UrlImageSource:
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
class SearchResultBlockParam:
List<TextBlockParam> content
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
Optional<List<TextCitationParam>> citations
class CitationCharLocationParam:
class CitationPageLocationParam:
class CitationContentBlockLocationParam:
class CitationWebSearchResultLocationParam:
class CitationSearchResultLocationParam:
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
Optional<CitationsConfigParam> citations
class DocumentBlockParam:
Source source
class Base64PdfSource:
class PlainTextSource:
class ContentBlockSource:
Content content
class TextBlockParam:
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
Optional<List<TextCitationParam>> citations
class CitationCharLocationParam:
class CitationPageLocationParam:
class CitationContentBlockLocationParam:
class CitationWebSearchResultLocationParam:
class CitationSearchResultLocationParam:
class ImageBlockParam:
Source source
class Base64ImageSource:
MediaType mediaType
class UrlImageSource:
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
class UrlPdfSource:
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
Optional<CitationsConfigParam> citations
class ToolReferenceBlockParam:Tool reference block that can be included in tool_result content.
Tool reference block that can be included in tool_result content.
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
class ServerToolUseBlockParam:
Name name
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
Optional<Caller> callerTool invocation directly from the model.
Tool invocation directly from the model.
class DirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class ServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class ServerToolCaller20260120:
class WebSearchToolResultBlockParam:
class WebSearchToolRequestError:
WebSearchToolResultErrorCode errorCode
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
Optional<Caller> callerTool invocation directly from the model.
Tool invocation directly from the model.
class DirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class ServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class ServerToolCaller20260120:
class WebFetchToolResultBlockParam:
Content content
class WebFetchToolResultErrorBlockParam:
WebFetchToolResultErrorCode errorCode
class WebFetchBlockParam:
DocumentBlockParam content
Source source
class Base64PdfSource:
class PlainTextSource:
class ContentBlockSource:
Content content
class TextBlockParam:
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
Optional<List<TextCitationParam>> citations
class CitationCharLocationParam:
class CitationPageLocationParam:
class CitationContentBlockLocationParam:
class CitationWebSearchResultLocationParam:
class CitationSearchResultLocationParam:
class ImageBlockParam:
Source source
class Base64ImageSource:
MediaType mediaType
class UrlImageSource:
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
class UrlPdfSource:
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
Optional<CitationsConfigParam> citations
Fetched content URL
ISO 8601 timestamp when the content was retrieved
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
Optional<Caller> callerTool invocation directly from the model.
Tool invocation directly from the model.
class DirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class ServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class ServerToolCaller20260120:
class CodeExecutionToolResultBlockParam:
Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
class CodeExecutionToolResultErrorParam:
CodeExecutionToolResultErrorCode errorCode
class CodeExecutionResultBlockParam:
List<CodeExecutionOutputBlockParam> content
class EncryptedCodeExecutionResultBlockParam:Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
List<CodeExecutionOutputBlockParam> content
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
class BashCodeExecutionToolResultBlockParam:
Content content
class BashCodeExecutionToolResultErrorParam:
BashCodeExecutionToolResultErrorCode errorCode
class BashCodeExecutionResultBlockParam:
List<BashCodeExecutionOutputBlockParam> content
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
class TextEditorCodeExecutionToolResultBlockParam:
Content content
class TextEditorCodeExecutionToolResultErrorParam:
class TextEditorCodeExecutionViewResultBlockParam:
FileType fileType
class TextEditorCodeExecutionCreateResultBlockParam:
class TextEditorCodeExecutionStrReplaceResultBlockParam:
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
class ToolSearchToolResultBlockParam:
Content content
class ToolSearchToolResultErrorParam:
ToolSearchToolResultErrorCode errorCode
class ToolSearchToolSearchResultBlockParam:
List<ToolReferenceBlockParam> toolReferences
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
class ContainerUploadBlockParam: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.
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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 role
Model modelThe model that will complete your prompt.
The model that will complete your prompt.
See models for additional details and options.
Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request.
Configuration options for the model's output, such as the output format.
Optional<System> systemSystem prompt.
System prompt.
A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our guide to system prompts.
List<TextBlockParam>
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
Optional<List<TextCitationParam>> citations
class CitationCharLocationParam:
class CitationPageLocationParam:
class CitationContentBlockLocationParam:
class CitationWebSearchResultLocationParam:
class CitationSearchResultLocationParam:
Optional<ThinkingConfigParam> thinkingConfiguration for enabling Claude's extended thinking.
Configuration for enabling Claude's extended thinking.
When enabled, responses include thinking content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your max_tokens limit.
See extended thinking for details.
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.
Optional<List<MessageCountTokensTool>> toolsDefinitions of tools that the model may use.
Definitions of tools that the model may use.
If you include tools in your API request, the model may return tool_use content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using tool_result content blocks.
There are two types of tools: client tools and server tools. The behavior described below applies to client tools. For server tools, see their individual documentation as each has its own behavior (e.g., the web search tool).
Each tool definition includes:
name: Name of the tool.description: Optional, but strongly-recommended description of the tool.input_schema: JSON schema for the toolinputshape that the model will produce intool_useoutput content blocks.
For example, if you defined tools as:
[
{
"name": "get_stock_price",
"description": "Get the current stock price for a given ticker symbol.",
"input_schema": {
"type": "object",
"properties": {
"ticker": {
"type": "string",
"description": "The stock ticker symbol, e.g. AAPL for Apple Inc."
}
},
"required": ["ticker"]
}
}
]
And then asked the model "What's the S&P 500 at today?", the model might produce tool_use content blocks in the response like this:
[
{
"type": "tool_use",
"id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
"name": "get_stock_price",
"input": { "ticker": "^GSPC" }
}
]
You might then run your get_stock_price tool with {"ticker": "^GSPC"} as an input, and return the following back to the model in a subsequent user message:
[
{
"type": "tool_result",
"tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
"content": "259.75 USD"
}
]
Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output.
See our guide for more details.
class Tool:
InputSchema inputSchemaJSON 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.
String nameName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Optional<List<AllowedCaller>> allowedCallers
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
Optional<String> descriptionDescription 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
class ToolBash20250124:
JsonValue; name "bash"constant"bash"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Optional<List<AllowedCaller>> allowedCallers
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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
class CodeExecutionTool20250522:
JsonValue; name "code_execution"constant"code_execution"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Optional<List<AllowedCaller>> allowedCallers
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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
class CodeExecutionTool20250825:
JsonValue; name "code_execution"constant"code_execution"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Optional<List<AllowedCaller>> allowedCallers
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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
class CodeExecutionTool20260120:Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
JsonValue; name "code_execution"constant"code_execution"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Optional<List<AllowedCaller>> allowedCallers
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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
class MemoryTool20250818:
JsonValue; name "memory"constant"memory"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Optional<List<AllowedCaller>> allowedCallers
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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
class ToolTextEditor20250124:
JsonValue; name "str_replace_editor"constant"str_replace_editor"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Optional<List<AllowedCaller>> allowedCallers
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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
class ToolTextEditor20250429:
JsonValue; name "str_replace_based_edit_tool"constant"str_replace_based_edit_tool"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Optional<List<AllowedCaller>> allowedCallers
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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
class ToolTextEditor20250728:
JsonValue; name "str_replace_based_edit_tool"constant"str_replace_based_edit_tool"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Optional<List<AllowedCaller>> allowedCallers
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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
class WebSearchTool20250305:
JsonValue; name "web_search"constant"web_search"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Optional<List<AllowedCaller>> allowedCallers
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.
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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
Optional<UserLocation> userLocationParameters 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.
class WebFetchTool20250910:
JsonValue; name "web_fetch"constant"web_fetch"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Optional<List<AllowedCaller>> allowedCallers
List of domains to allow fetching from
List of domains to block fetching from
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
Optional<CitationsConfigParam> citationsCitations 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
class WebSearchTool20260209:
JsonValue; name "web_search"constant"web_search"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Optional<List<AllowedCaller>> allowedCallers
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.
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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
Optional<UserLocation> userLocationParameters 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.
class WebFetchTool20260209:
JsonValue; name "web_fetch"constant"web_fetch"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Optional<List<AllowedCaller>> allowedCallers
List of domains to allow fetching from
List of domains to block fetching from
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
Optional<CitationsConfigParam> citationsCitations 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
class ToolSearchToolBm25_20251119:
JsonValue; name "tool_search_tool_bm25"constant"tool_search_tool_bm25"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Type type
Optional<List<AllowedCaller>> allowedCallers
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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
class ToolSearchToolRegex20251119:
JsonValue; name "tool_search_tool_regex"constant"tool_search_tool_regex"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Type type
Optional<List<AllowedCaller>> allowedCallers
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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
ReturnsExpand Collapse
class MessageTokensCount:
The total number of tokens across the provided list of messages, system prompt, and tools.
package com.anthropic.example;
import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import com.anthropic.models.messages.MessageCountTokensParams;
import com.anthropic.models.messages.MessageTokensCount;
import com.anthropic.models.messages.Model;
public final class Main {
private Main() {}
public static void main(String[] args) {
AnthropicClient client = AnthropicOkHttpClient.fromEnv();
MessageCountTokensParams params = MessageCountTokensParams.builder()
.addUserMessage("Hello, world")
.model(Model.CLAUDE_OPUS_4_6)
.build();
MessageTokensCount messageTokensCount = client.messages().countTokens(params);
}
}{
"input_tokens": 2095
}Returns Examples
{
"input_tokens": 2095
}