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
Optional<List<AnthropicBeta>> betas
Optional header to specify the beta version(s) you want to use.
List<BetaMessageParam> 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<BetaContentBlockParam>
class BetaTextBlockParam:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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 BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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 BetaRequestDocumentBlock:
Source source
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
class BetaContentBlockSource:
Content content
class BetaTextBlockParam:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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 BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "content"constant"content"constant
class BetaUrlPdfSource:
JsonValue; type "url"constant"url"constant
class BetaFileDocumentSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "document"constant"document"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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 BetaSearchResultBlockParam:
List<BetaTextBlockParam> content
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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 BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "search_result"constant"search_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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 BetaThinkingBlockParam:
JsonValue; type "thinking"constant"thinking"constant
class BetaRedactedThinkingBlockParam:
JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
class BetaToolUseBlockParam:
JsonValue; type "tool_use"constant"tool_use"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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> caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
class BetaToolResultBlockParam:
JsonValue; type "tool_result"constant"tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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 BetaTextBlockParam:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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 BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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 BetaSearchResultBlockParam:
List<BetaTextBlockParam> content
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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 BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "search_result"constant"search_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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 BetaRequestDocumentBlock:
Source source
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
class BetaContentBlockSource:
Content content
class BetaTextBlockParam:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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 BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "content"constant"content"constant
class BetaUrlPdfSource:
JsonValue; type "url"constant"url"constant
class BetaFileDocumentSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "document"constant"document"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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 BetaToolReferenceBlockParam:
Tool reference block that can be included in tool_result content.
JsonValue; type "tool_reference"constant"tool_reference"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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 BetaServerToolUseBlockParam:
Name name
JsonValue; type "server_tool_use"constant"server_tool_use"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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> caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
class BetaWebSearchToolResultBlockParam:
JsonValue; type "web_search_result"constant"web_search_result"constant
class BetaWebSearchToolRequestError:
BetaWebSearchToolResultErrorCode errorCode
JsonValue; type "web_search_tool_result_error"constant"web_search_tool_result_error"constant
JsonValue; type "web_search_tool_result"constant"web_search_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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 BetaWebFetchToolResultBlockParam:
Content content
class BetaWebFetchToolResultErrorBlockParam:
BetaWebFetchToolResultErrorCode errorCode
JsonValue; type "web_fetch_tool_result_error"constant"web_fetch_tool_result_error"constant
class BetaWebFetchBlockParam:
BetaRequestDocumentBlock content
Source source
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
class BetaContentBlockSource:
Content content
class BetaTextBlockParam:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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 BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "content"constant"content"constant
class BetaUrlPdfSource:
JsonValue; type "url"constant"url"constant
class BetaFileDocumentSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "document"constant"document"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "web_fetch_result"constant"web_fetch_result"constant
String url
Fetched content URL
Optional<String> retrievedAt
ISO 8601 timestamp when the content was retrieved
JsonValue; type "web_fetch_tool_result"constant"web_fetch_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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 BetaCodeExecutionToolResultBlockParam:
class BetaCodeExecutionToolResultErrorParam:
BetaCodeExecutionToolResultErrorCode errorCode
JsonValue; type "code_execution_tool_result_error"constant"code_execution_tool_result_error"constant
class BetaCodeExecutionResultBlockParam:
List<BetaCodeExecutionOutputBlockParam> content
JsonValue; type "code_execution_output"constant"code_execution_output"constant
JsonValue; type "code_execution_result"constant"code_execution_result"constant
JsonValue; type "code_execution_tool_result"constant"code_execution_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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 BetaBashCodeExecutionToolResultBlockParam:
Content content
class BetaBashCodeExecutionToolResultErrorParam:
ErrorCode errorCode
JsonValue; type "bash_code_execution_tool_result_error"constant"bash_code_execution_tool_result_error"constant
class BetaBashCodeExecutionResultBlockParam:
List<BetaBashCodeExecutionOutputBlockParam> content
JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
JsonValue; type "bash_code_execution_tool_result"constant"bash_code_execution_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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 BetaTextEditorCodeExecutionToolResultBlockParam:
Content content
class BetaTextEditorCodeExecutionToolResultErrorParam:
ErrorCode errorCode
JsonValue; type "text_editor_code_execution_tool_result_error"constant"text_editor_code_execution_tool_result_error"constant
class BetaTextEditorCodeExecutionViewResultBlockParam:
FileType fileType
JsonValue; type "text_editor_code_execution_view_result"constant"text_editor_code_execution_view_result"constant
class BetaTextEditorCodeExecutionCreateResultBlockParam:
JsonValue; type "text_editor_code_execution_create_result"constant"text_editor_code_execution_create_result"constant
class BetaTextEditorCodeExecutionStrReplaceResultBlockParam:
JsonValue; type "text_editor_code_execution_str_replace_result"constant"text_editor_code_execution_str_replace_result"constant
JsonValue; type "text_editor_code_execution_tool_result"constant"text_editor_code_execution_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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 BetaToolSearchToolResultBlockParam:
Content content
class BetaToolSearchToolResultErrorParam:
ErrorCode errorCode
JsonValue; type "tool_search_tool_result_error"constant"tool_search_tool_result_error"constant
class BetaToolSearchToolSearchResultBlockParam:
List<BetaToolReferenceBlockParam> toolReferences
JsonValue; type "tool_reference"constant"tool_reference"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "tool_search_tool_search_result"constant"tool_search_tool_search_result"constant
JsonValue; type "tool_search_tool_result"constant"tool_search_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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 BetaMcpToolUseBlockParam:
String serverName
The name of the MCP server
JsonValue; type "mcp_tool_use"constant"mcp_tool_use"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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 BetaRequestMcpToolResultBlockParam:
JsonValue; type "mcp_tool_result"constant"mcp_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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<BetaTextBlockParam>
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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 BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaContainerUploadBlockParam:
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.
JsonValue; type "container_upload"constant"container_upload"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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 model
The model that will complete your prompt.
See models for additional details and options.
Context management configuration.
This allows you to control how Claude manages context across multiple requests, such as whether to clear function results or not.
MCP servers to be utilized in this request
JsonValue; type "url"constant"url"constant
Configuration options for the model's output. Controls aspects like how much effort the model puts into its response.
A schema to specify Claude's output format in responses.
Optional<System> system
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<BetaTextBlockParam>
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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 BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
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<Tool>> tools
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 BetaTool:
InputSchema inputSchema
JSON schema for this tool's input.
This defines the shape of the input that your tool accepts and that the model will produce.
JsonValue; type "object"constant"object"constant
String name
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Optional<String> description
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.
Optional<Type> type
class BetaToolBash20241022:
JsonValue; name "bash"constant"bash"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "bash_20241022"constant"bash_20241022"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolBash20250124:
JsonValue; name "bash"constant"bash"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "bash_20250124"constant"bash_20250124"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaCodeExecutionTool20250522:
JsonValue; name "code_execution"constant"code_execution"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "code_execution_20250522"constant"code_execution_20250522"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaCodeExecutionTool20250825:
JsonValue; name "code_execution"constant"code_execution"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolComputerUse20241022:
long displayHeightPx
The height of the display in pixels.
long displayWidthPx
The width of the display in pixels.
JsonValue; name "computer"constant"computer"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "computer_20241022"constant"computer_20241022"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Optional<Long> displayNumber
The X11 display number (e.g. 0, 1) for the display.
class BetaMemoryTool20250818:
JsonValue; name "memory"constant"memory"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "memory_20250818"constant"memory_20250818"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolComputerUse20250124:
long displayHeightPx
The height of the display in pixels.
long displayWidthPx
The width of the display in pixels.
JsonValue; name "computer"constant"computer"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "computer_20250124"constant"computer_20250124"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Optional<Long> displayNumber
The X11 display number (e.g. 0, 1) for the display.
class BetaToolTextEditor20241022:
JsonValue; name "str_replace_editor"constant"str_replace_editor"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "text_editor_20241022"constant"text_editor_20241022"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolComputerUse20251124:
long displayHeightPx
The height of the display in pixels.
long displayWidthPx
The width of the display in pixels.
JsonValue; name "computer"constant"computer"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "computer_20251124"constant"computer_20251124"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Optional<Long> displayNumber
The X11 display number (e.g. 0, 1) for the display.
Optional<Boolean> enableZoom
Whether to enable an action to take a zoomed-in screenshot of the screen.
class BetaToolTextEditor20250124:
JsonValue; name "str_replace_editor"constant"str_replace_editor"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "text_editor_20250124"constant"text_editor_20250124"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolTextEditor20250429:
JsonValue; name "str_replace_based_edit_tool"constant"str_replace_based_edit_tool"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "text_editor_20250429"constant"text_editor_20250429"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolTextEditor20250728:
JsonValue; name "str_replace_based_edit_tool"constant"str_replace_based_edit_tool"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "text_editor_20250728"constant"text_editor_20250728"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Optional<Long> maxCharacters
Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.
class BetaWebSearchTool20250305:
JsonValue; name "web_search"constant"web_search"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "web_search_20250305"constant"web_search_20250305"constant
Optional<List<AllowedCaller>> allowedCallers
Optional<List<String>> allowedDomains
If provided, only these domains will be included in results. Cannot be used alongside blocked_domains.
Optional<List<String>> blockedDomains
If provided, these domains will never appear in results. Cannot be used alongside allowed_domains.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Optional<Long> maxUses
Maximum number of times the tool can be used in the API request.
Optional<UserLocation> userLocation
Parameters for the user's location. Used to provide more relevant search results.
JsonValue; type "approximate"constant"approximate"constant
Optional<String> city
The city of the user.
Optional<String> country
The two letter ISO country code of the user.
Optional<String> region
The region of the user.
Optional<String> timezone
The IANA timezone of the user.
class BetaWebFetchTool20250910:
JsonValue; name "web_fetch"constant"web_fetch"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "web_fetch_20250910"constant"web_fetch_20250910"constant
Optional<List<AllowedCaller>> allowedCallers
Optional<List<String>> allowedDomains
List of domains to allow fetching from
Optional<List<String>> blockedDomains
List of domains to block fetching from
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Citations configuration for fetched documents. Citations are disabled by default.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Optional<Long> maxContentTokens
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.
Optional<Long> maxUses
Maximum number of times the tool can be used in the API request.
class BetaToolSearchToolBm25_20251119:
JsonValue; name "tool_search_tool_bm25"constant"tool_search_tool_bm25"constant
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
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolSearchToolRegex20251119:
JsonValue; name "tool_search_tool_regex"constant"tool_search_tool_regex"constant
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
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaMcpToolset:
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.
String mcpServerName
Name of the MCP server to configure tools for
JsonValue; type "mcp_toolset"constant"mcp_toolset"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
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<Configs> configs
Configuration overrides for specific tools, keyed by tool name
Default configuration applied to all tools from this server
ReturnsExpand Collapse
class BetaMessageTokensCount:
Information about context management applied to the message.
long originalInputTokens
The original token count before context management was applied
long inputTokens
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.beta.messages.BetaMessageTokensCount;
import com.anthropic.models.beta.messages.MessageCountTokensParams;
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_5_20251101)
.build();
BetaMessageTokensCount betaMessageTokensCount = client.beta().messages().countTokens(params);
}
}{
"context_management": {
"original_input_tokens": 0
},
"input_tokens": 2095
}Returns Examples
{
"context_management": {
"original_input_tokens": 0
},
"input_tokens": 2095
}