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 parameters
required IReadOnlyList<BetaMessageParam> messagesBody param: Input messages.
Body param: Input messages.
Our models are trained to operate on alternating user and assistant conversational turns. When creating a new Message, you specify the prior conversational turns with the messages parameter, and the model then generates the next Message in the conversation. Consecutive user or assistant turns in your request will be combined into a single turn.
Each input message must be an object with a role and content. You can specify a single user-role message, or you can include multiple user and assistant messages.
If the final message uses the assistant role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response.
Example with a single user message:
[{"role": "user", "content": "Hello, Claude"}]
Example with multiple conversational turns:
[
{"role": "user", "content": "Hello there."},
{"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"},
{"role": "user", "content": "Can you explain LLMs in plain English?"},
]
Example with a partially-filled response from Claude:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("},
]
Each input message content may be either a single string or an array of content blocks, where each block has a specific type. Using a string for content is shorthand for an array of one content block of type "text". The following input messages are equivalent:
{"role": "user", "content": "Hello, Claude"}
{"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]}
See input examples.
Note that if you want to include a system prompt, you can use the top-level system parameter — there is no "system" role for input messages in the Messages API.
There is a limit of 100,000 messages in a single request.
required Content Content
IReadOnlyList<BetaContentBlockParam>
class BetaTextBlockParam:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
IReadOnlyList<BetaTextCitationParam>? Citations
class BetaCitationCharLocationParam:
class BetaCitationPageLocationParam:
class BetaCitationContentBlockLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationSearchResultLocationParam:
class BetaImageBlockParam:
required Source Source
class BetaBase64ImageSource:
required MediaType MediaType
class BetaUrlImageSource:
class BetaFileImageSource:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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 BetaRequestDocumentBlock:
required Source Source
class BetaBase64PdfSource:
class BetaPlainTextSource:
class BetaContentBlockSource:
required Content Content
IReadOnlyList<BetaContentBlockSourceContent>
class BetaTextBlockParam:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
IReadOnlyList<BetaTextCitationParam>? Citations
class BetaCitationCharLocationParam:
class BetaCitationPageLocationParam:
class BetaCitationContentBlockLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationSearchResultLocationParam:
class BetaImageBlockParam:
required Source Source
class BetaBase64ImageSource:
required MediaType MediaType
class BetaUrlImageSource:
class BetaFileImageSource:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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 BetaUrlPdfSource:
class BetaFileDocumentSource:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
BetaCitationsConfigParam? Citations
class BetaSearchResultBlockParam:
required IReadOnlyList<BetaTextBlockParam> Content
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
IReadOnlyList<BetaTextCitationParam>? Citations
class BetaCitationCharLocationParam:
class BetaCitationPageLocationParam:
class BetaCitationContentBlockLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationSearchResultLocationParam:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
BetaCitationsConfigParam Citations
class BetaThinkingBlockParam:
class BetaRedactedThinkingBlockParam:
class BetaToolUseBlockParam:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaToolResultBlockParam:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
Content Content
IReadOnlyList<Block>
class BetaTextBlockParam:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
IReadOnlyList<BetaTextCitationParam>? Citations
class BetaCitationCharLocationParam:
class BetaCitationPageLocationParam:
class BetaCitationContentBlockLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationSearchResultLocationParam:
class BetaImageBlockParam:
required Source Source
class BetaBase64ImageSource:
required MediaType MediaType
class BetaUrlImageSource:
class BetaFileImageSource:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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 BetaSearchResultBlockParam:
required IReadOnlyList<BetaTextBlockParam> Content
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
IReadOnlyList<BetaTextCitationParam>? Citations
class BetaCitationCharLocationParam:
class BetaCitationPageLocationParam:
class BetaCitationContentBlockLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationSearchResultLocationParam:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
BetaCitationsConfigParam Citations
class BetaRequestDocumentBlock:
required Source Source
class BetaBase64PdfSource:
class BetaPlainTextSource:
class BetaContentBlockSource:
required Content Content
IReadOnlyList<BetaContentBlockSourceContent>
class BetaTextBlockParam:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
IReadOnlyList<BetaTextCitationParam>? Citations
class BetaCitationCharLocationParam:
class BetaCitationPageLocationParam:
class BetaCitationContentBlockLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationSearchResultLocationParam:
class BetaImageBlockParam:
required Source Source
class BetaBase64ImageSource:
required MediaType MediaType
class BetaUrlImageSource:
class BetaFileImageSource:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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 BetaUrlPdfSource:
class BetaFileDocumentSource:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
BetaCitationsConfigParam? Citations
class BetaToolReferenceBlockParam:Tool reference block that can be included in tool_result content.
Tool reference block that can be included in tool_result content.
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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 BetaServerToolUseBlockParam:
required Name Name
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaWebSearchToolResultBlockParam:
required BetaWebSearchToolResultBlockParamContent Content
IReadOnlyList<BetaWebSearchResultBlockParam>
class BetaWebSearchToolRequestError:
required BetaWebSearchToolResultErrorCode ErrorCode
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaWebFetchToolResultBlockParam:
required Content Content
class BetaWebFetchToolResultErrorBlockParam:
required BetaWebFetchToolResultErrorCode ErrorCode
class BetaWebFetchBlockParam:
required BetaRequestDocumentBlock Content
required Source Source
class BetaBase64PdfSource:
class BetaPlainTextSource:
class BetaContentBlockSource:
required Content Content
IReadOnlyList<BetaContentBlockSourceContent>
class BetaTextBlockParam:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
IReadOnlyList<BetaTextCitationParam>? Citations
class BetaCitationCharLocationParam:
class BetaCitationPageLocationParam:
class BetaCitationContentBlockLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationSearchResultLocationParam:
class BetaImageBlockParam:
required Source Source
class BetaBase64ImageSource:
required MediaType MediaType
class BetaUrlImageSource:
class BetaFileImageSource:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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 BetaUrlPdfSource:
class BetaFileDocumentSource:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
BetaCitationsConfigParam? Citations
Fetched content URL
ISO 8601 timestamp when the content was retrieved
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaCodeExecutionToolResultBlockParam:
required BetaCodeExecutionToolResultBlockParamContent ContentCode execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
class BetaCodeExecutionToolResultErrorParam:
required BetaCodeExecutionToolResultErrorCode ErrorCode
class BetaCodeExecutionResultBlockParam:
required IReadOnlyList<BetaCodeExecutionOutputBlockParam> Content
class BetaEncryptedCodeExecutionResultBlockParam:Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
required IReadOnlyList<BetaCodeExecutionOutputBlockParam> Content
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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 BetaBashCodeExecutionToolResultBlockParam:
required Content Content
class BetaBashCodeExecutionToolResultErrorParam:
required ErrorCode ErrorCode
class BetaBashCodeExecutionResultBlockParam:
required IReadOnlyList<BetaBashCodeExecutionOutputBlockParam> Content
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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 BetaTextEditorCodeExecutionToolResultBlockParam:
required Content Content
class BetaTextEditorCodeExecutionToolResultErrorParam:
required ErrorCode ErrorCode
class BetaTextEditorCodeExecutionViewResultBlockParam:
required FileType FileType
class BetaTextEditorCodeExecutionCreateResultBlockParam:
class BetaTextEditorCodeExecutionStrReplaceResultBlockParam:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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 BetaToolSearchToolResultBlockParam:
required Content Content
class BetaToolSearchToolResultErrorParam:
required ErrorCode ErrorCode
class BetaToolSearchToolSearchResultBlockParam:
required IReadOnlyList<BetaToolReferenceBlockParam> ToolReferences
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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 BetaMcpToolUseBlockParam:
The name of the MCP server
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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 BetaRequestMcpToolResultBlockParam:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
Content Content
IReadOnlyList<BetaTextBlockParam>
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
IReadOnlyList<BetaTextCitationParam>? Citations
class BetaCitationCharLocationParam:
class BetaCitationPageLocationParam:
class BetaCitationContentBlockLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationSearchResultLocationParam:
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.
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.
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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 BetaCompactionBlockParam:A compaction block containing summary of previous context.
A compaction block containing summary of previous context.
Users should round-trip these blocks from responses to subsequent requests to maintain context across compaction boundaries.
When content is None, the block represents a failed compaction. The server treats these as no-ops. Empty string content is not allowed.
Summary of previously compacted content, or null if compaction failed
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
required Role Role
Body param: Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request.
BetaContextManagementConfig? contextManagementBody param: Context management configuration.
Body param: Context management configuration.
This allows you to control how Claude manages context across multiple requests, such as whether to clear function results or not.
IReadOnlyList<BetaRequestMcpServerUrlDefinition> mcpServersBody param: MCP servers to be utilized in this request
Body param: MCP servers to be utilized in this request
BetaRequestMcpServerToolConfiguration? ToolConfiguration
Body param: Configuration options for the model's output, such as the output format.
DeprecatedBetaJsonOutputFormat? outputFormatBody param: Deprecated: Use output_config.format instead. See structured outputs
Body param: Deprecated: Use output_config.format instead. See structured outputs
A schema to specify Claude's output format in responses. This parameter will be removed in a future release.
Speed? speedBody param: The inference speed mode for this request. "fast" enables high output-tokens-per-second inference.
Body param: The inference speed mode for this request. "fast" enables high output-tokens-per-second inference.
System systemBody param: System prompt.
Body param: System prompt.
A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our guide to system prompts.
IReadOnlyList<BetaTextBlockParam>
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
IReadOnlyList<BetaTextCitationParam>? Citations
class BetaCitationCharLocationParam:
class BetaCitationPageLocationParam:
class BetaCitationContentBlockLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationSearchResultLocationParam:
BetaThinkingConfigParam thinkingBody param: Configuration for enabling Claude's extended thinking.
Body param: Configuration for enabling Claude's extended thinking.
When enabled, responses include thinking content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your max_tokens limit.
See extended thinking for details.
Body param: How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all.
IReadOnlyList<Tool> toolsBody param: Definitions of tools that the model may use.
Body param: Definitions of tools that the model may use.
If you include tools in your API request, the model may return tool_use content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using tool_result content blocks.
There are two types of tools: client tools and server tools. The behavior described below applies to client tools. For server tools, see their individual documentation as each has its own behavior (e.g., the web search tool).
Each tool definition includes:
name: Name of the tool.description: Optional, but strongly-recommended description of the tool.input_schema: JSON schema for the toolinputshape that the model will produce intool_useoutput content blocks.
For example, if you defined tools as:
[
{
"name": "get_stock_price",
"description": "Get the current stock price for a given ticker symbol.",
"input_schema": {
"type": "object",
"properties": {
"ticker": {
"type": "string",
"description": "The stock ticker symbol, e.g. AAPL for Apple Inc."
}
},
"required": ["ticker"]
}
}
]
And then asked the model "What's the S&P 500 at today?", the model might produce tool_use content blocks in the response like this:
[
{
"type": "tool_use",
"id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
"name": "get_stock_price",
"input": { "ticker": "^GSPC" }
}
]
You might then run your get_stock_price tool with {"ticker": "^GSPC"} as an input, and return the following back to the model in a subsequent user message:
[
{
"type": "tool_result",
"tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
"content": "259.75 USD"
}
]
Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output.
See our guide for more details.
class BetaTool:
required 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.
required 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.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
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 BetaToolBash20241022:
JsonElement Name "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.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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 BetaToolBash20250124:
JsonElement Name "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.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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 BetaCodeExecutionTool20250522:
JsonElement Name "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.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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 BetaCodeExecutionTool20250825:
JsonElement Name "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.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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 BetaCodeExecutionTool20260120:Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
JsonElement Name "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.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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 BetaToolComputerUse20241022:
The height of the display in pixels.
The width of the display in pixels.
JsonElement Name "computer"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
The X11 display number (e.g. 0, 1) for the display.
When true, guarantees schema validation on tool names and inputs
class BetaMemoryTool20250818:
JsonElement Name "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.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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 BetaToolComputerUse20250124:
The height of the display in pixels.
The width of the display in pixels.
JsonElement Name "computer"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
The X11 display number (e.g. 0, 1) for the display.
When true, guarantees schema validation on tool names and inputs
class BetaToolTextEditor20241022:
JsonElement Name "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.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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 BetaToolComputerUse20251124:
The height of the display in pixels.
The width of the display in pixels.
JsonElement Name "computer"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
The X11 display number (e.g. 0, 1) for the display.
Whether to enable an action to take a zoomed-in screenshot of the screen.
When true, guarantees schema validation on tool names and inputs
class BetaToolTextEditor20250124:
JsonElement Name "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.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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 BetaToolTextEditor20250429:
JsonElement Name "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.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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 BetaToolTextEditor20250728:
JsonElement Name "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.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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 BetaWebSearchTool20250305:
JsonElement Name "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.
IReadOnlyList<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.
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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
BetaUserLocation? 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 BetaWebFetchTool20250910:
JsonElement Name "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.
IReadOnlyList<AllowedCaller> AllowedCallers
List of domains to allow fetching from
List of domains to block fetching from
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
BetaCitationsConfigParam? 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 BetaWebSearchTool20260209:
JsonElement Name "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.
IReadOnlyList<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.
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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
BetaUserLocation? 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 BetaWebFetchTool20260209:
JsonElement Name "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.
IReadOnlyList<AllowedCaller> AllowedCallers
List of domains to allow fetching from
List of domains to block fetching from
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
BetaCitationsConfigParam? 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 BetaToolSearchToolBm25_20251119:
JsonElement Name "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.
required Type Type
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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 BetaToolSearchToolRegex20251119:
JsonElement Name "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.
required Type Type
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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 BetaMcpToolset:Configuration for a group of tools from an MCP server.
Configuration for a group of tools from an MCP server.
Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides.
Name of the MCP server to configure tools for
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
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.
IReadOnlyDictionary<string, BetaMcpToolConfig>? ConfigsConfiguration overrides for specific tools, keyed by tool name
Configuration overrides for specific tools, keyed by tool name
BetaMcpToolDefaultConfig DefaultConfigDefault configuration applied to all tools from this server
Default configuration applied to all tools from this server
IReadOnlyList<AnthropicBeta> betasHeader param: Optional header to specify the beta version(s) you want to use.
Header param: Optional header to specify the beta version(s) you want to use.
ReturnsExpand Collapse
class BetaMessageTokensCount:
required BetaCountTokensContextManagementResponse? ContextManagementInformation about context management applied to the message.
Information about context management applied to the message.
The original token count before context management was applied
The total number of tokens across the provided list of messages, system prompt, and tools.
MessageCountTokensParams parameters = new()
{
Messages =
[
new()
{
Content = "string",
Role = Role.User,
},
],
Model = Model.ClaudeOpus4_6,
};
var betaMessageTokensCount = await client.Beta.Messages.CountTokens(parameters);
Console.WriteLine(betaMessageTokensCount);{
"context_management": {
"original_input_tokens": 0
},
"input_tokens": 2095
}Returns Examples
{
"context_management": {
"original_input_tokens": 0
},
"input_tokens": 2095
}