メッセージ内のトークンをカウント
メッセージ内のトークン数をカウントします。
Token Count APIを使用すると、ツール、画像、ドキュメントを含むメッセージのトークン数を、メッセージを作成せずにカウントできます。
トークンカウントの詳細については、ユーザーガイドをご覧ください。
Parameters
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 { Type = "text"; Text; CacheControl; Citations; }
class BetaImageBlockParam { Type = "image"; Source; CacheControl; Transformations; }
class BetaRequestDocumentBlock { Type = "document"; Source; CacheControl; /* 3 more */ }
class BetaSearchResultBlockParam { Type = "search_result"; Content; Source; /* 3 more */ }
class BetaThinkingBlockParam { Type = "thinking"; Signature; Thinking; }
required string SignatureThe signature value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude.
The signature value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude.
Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 invalid_request_error.
The thinking text of this block as returned by the API.
class BetaRedactedThinkingBlockParam { Type = "redacted_thinking"; Data; }
The data value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged.
class BetaToolUseBlockParam { Type = "tool_use"; ID; Input; /* 4 more */ }
class BetaToolResultBlockParam { Type = "tool_result"; ToolUseID; CacheControl; /* 3 more */ }
class BetaServerToolUseBlockParam { Type = "server_tool_use"; ID; Input; /* 3 more */ }
class BetaWebSearchToolResultBlockParam { Type = "web_search_tool_result"; Content; ToolUseID; /* 2 more */ }
class BetaWebFetchToolResultBlockParam { Type = "web_fetch_tool_result"; Content; ToolUseID; /* 2 more */ }
class BetaAdvisorToolResultBlockParam { Type = "advisor_tool_result"; Content; ToolUseID; CacheControl; }
class BetaCodeExecutionToolResultBlockParam { Type = "code_execution_tool_result"; Content; ToolUseID; CacheControl; }
required BetaCodeExecutionToolResultBlockParamContent Content
required string ToolUseID
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. See prompt caching pricing for details.
class BetaBashCodeExecutionToolResultBlockParam { Type = "bash_code_execution_tool_result"; Content; ToolUseID; CacheControl; }
class BetaTextEditorCodeExecutionToolResultBlockParam { Type = "text_editor_code_execution_tool_result"; Content; ToolUseID; CacheControl; }
class BetaToolSearchToolResultBlockParam { Type = "tool_search_tool_result"; Content; ToolUseID; CacheControl; }
class BetaMcpToolUseBlockParam { Type = "mcp_tool_use"; ID; Input; /* 3 more */ }
required string ID
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. See prompt caching pricing for details.
class BetaRequestMcpToolResultBlockParam { Type = "mcp_tool_result"; ToolUseID; CacheControl; /* 2 more */ }
class BetaContainerUploadBlockParam { Type = "container_upload"; FileID; CacheControl; }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. See prompt caching pricing for details.
class BetaCompactionBlockParam { Type = "compaction"; CacheControl; Content; /* 2 more */ }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.
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. See prompt caching pricing for details.
Summary of previously compacted content, or null if compaction failed
Opaque metadata from prior compaction, to be round-tripped verbatim
The block's signature as returned, to be sent back verbatim
class BetaRequestToolAdditionBlock { Type = "tool_addition"; Tool; CacheControl; }Mid-conversation directive to surface a declared tool.
Mid-conversation directive to surface a declared tool.
tool references a tool (or MCP toolset) by name from the request's
tools; it is offered to the model from this point in the
conversation onward.
class BetaRequestToolRemovalBlock { Type = "tool_removal"; Tool; CacheControl; }Mid-conversation directive to withdraw a tool.
Mid-conversation directive to withdraw a tool.
tool references a tool (or MCP toolset) by name from the request's
tools; it is no longer offered to the model from this point in the
conversation onward.
class BetaFallbackBlockParam { Type = "fallback"; From; To; Trigger; }A fallback block echoed back from a prior response.
A fallback block echoed back from a prior response.
Accepted in messages[].content and not rendered into the prompt; not
validated against the request's fallbacks chain or top-level model.
Echo the assistant turn back verbatim, including this block in its original position. The block marks the boundary between content produced before and after a fallback hop, and the server relies on that boundary to validate the turn: when thinking runs flank the boundary, omitting the block merges them into one span the server cannot validate (the request is rejected), and moving it into the middle of a single run is likewise rejected; between non-thinking blocks the block's placement has no validation effect.
required BetaFallbackInfoParam FromIdentifies one hop of a fallback transition.
Identifies one hop of a fallback transition.
required BetaFallbackInfoParam ToIdentifies one hop of a fallback transition.
Identifies one hop of a fallback transition.
The response block's trigger, echoed verbatim. Accepted and ignored by the server; any object or null is allowed.
required Role Role
ClearAt? ClearAtHow long this system message's text stays in front of the model. "never" (the default) renders it on every request that includes it. "next_user_message" renders it only for the user turn it follows: once a later role: "user" message exists in messages the message stays in the array (send it unchanged) but is no longer shown to the model. Only permitted on role: "system" messages.
How long this system message's text stays in front of the model. "never" (the default) renders it on every request that includes it. "next_user_message" renders it only for the user turn it follows: once a later role: "user" message exists in messages the message stays in the array (send it unchanged) but is no longer shown to the model. Only permitted on role: "system" messages.
BetaSystemMessageOutputConfig? OutputConfigPer-message output configuration on a role:"system" input message.
Per-message output configuration on a role:"system" input message.
Fields here apply per-turn; format remains top-level only. An
empty {} is accepted on a message that carries content; a message
with neither content nor output_config fields is rejected.
Effort? EffortAll possible effort levels.
All possible effort levels.
Body param: Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request.
BetaCompactionConfig? compactionBody param: Compact the whole conversation and return a signed compaction block,
alone, that a later request sends back first in messages, in place of
the messages it summarizes. There is no trigger and no pause flag: sending
the parameter compacts, and nothing is sampled after the block.
Body param: Compact the whole conversation and return a signed compaction block,
alone, that a later request sends back first in messages, in place of
the messages it summarizes. There is no trigger and no pause flag: sending
the parameter compacts, and nothing is sampled after the block.
The summarization prompt is the server's own unless instructions are
given, which then replace it for this request; a value that is empty or
only whitespace counts as absent.
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.
Speed? speedBody param: Inference speed mode. fast provides significantly faster output token generation at premium pricing. Not all models support fast; invalid combinations are rejected at create time.
Body param: Inference speed mode. fast provides significantly faster output token generation at premium pricing. Not all models support fast; invalid combinations are rejected at create time.
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>
required string Text
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. See prompt caching pricing for details.
IReadOnlyList<BetaTextCitationParam>? Citations
class BetaCitationCharLocationParam { Type = "char_location"; CitedText; DocumentIndex; /* 3 more */ }
required long DocumentIndex
required string? DocumentTitle
required long StartCharIndex
class BetaCitationPageLocationParam { Type = "page_location"; CitedText; DocumentIndex; /* 3 more */ }
required long DocumentIndex
required string? DocumentTitle
required long StartPageNumber
class BetaCitationContentBlockLocationParam { Type = "content_block_location"; CitedText; DocumentIndex; /* 3 more */ }
required string CitedTextThe full text of the cited block range, concatenated.
The full text of the cited block range, concatenated.
Always equals the contents of content[start_block_index:end_block_index] joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns.
required long DocumentIndex
required string? DocumentTitle
required long EndBlockIndexExclusive 0-based end index of the cited block range in the source's content array.
Exclusive 0-based end index of the cited block range in the source's content array.
Always greater than start_block_index; a single-block citation has end_block_index = start_block_index + 1.
required long StartBlockIndex0-based index of the first cited block in the source's content array.
0-based index of the first cited block in the source's content array.
class BetaCitationWebSearchResultLocationParam { Type = "web_search_result_location"; CitedText; EncryptedIndex; /* 2 more */ }
required string? Title
required string Url
class BetaCitationSearchResultLocationParam { Type = "search_result_location"; CitedText; EndBlockIndex; /* 4 more */ }
required string CitedTextThe full text of the cited block range, concatenated.
The full text of the cited block range, concatenated.
Always equals the contents of content[start_block_index:end_block_index] joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns.
required long EndBlockIndexExclusive 0-based end index of the cited block range in the source's content array.
Exclusive 0-based end index of the cited block range in the source's content array.
Always greater than start_block_index; a single-block citation has end_block_index = start_block_index + 1.
required long SearchResultIndex0-based index of the cited search result among all search_result content blocks in the request, in the order they appear across messages and tool results.
0-based index of the cited search result among all search_result content blocks in the request, in the order they appear across messages and tool results.
Counted separately from document_index; server-side web search results are not included in this count.
required long StartBlockIndex0-based index of the first cited block in the source's content array.
0-based index of the first cited block in the source's content array.
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 { Type; InputSchema; Name; /* 7 more */ }
class BetaToolBash20241022 { Type = "bash_20241022"; Name; AllowedCallers; /* 4 more */ }
class BetaToolBash20250124 { Type = "bash_20250124"; Name; AllowedCallers; /* 4 more */ }
class BetaCodeExecutionTool20250522 { Type = "code_execution_20250522"; Name; AllowedCallers; /* 3 more */ }
class BetaCodeExecutionTool20250825 { Type = "code_execution_20250825"; Name; AllowedCallers; /* 3 more */ }
class BetaCodeExecutionTool20260120 { Type = "code_execution_20260120"; Name; AllowedCallers; /* 3 more */ }Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
class BetaCodeExecutionTool20260521 { Type = "code_execution_20260521"; Name; AllowedCallers; /* 3 more */ }Code execution tool with REPL state persistence.
Code execution tool with REPL state persistence.
class BetaBrowserToolset20260801 { Type = "browser_toolset_20260801"; CacheControl; Configs; }The browser toolset: a single tools[] entry (carrying no
name) that declares the browser tool family. The model is served
the family's tool with any members disabled via configs removed
from its schema.
The browser toolset: a single tools[] entry (carrying no
name) that declares the browser tool family. The model is served
the family's tool with any members disabled via configs removed
from its schema.
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. See prompt caching pricing for details.
BetaBrowserToolsetConfigs? ConfigsPer-member configuration for browser_toolset_20260801: one
optional field per member tool, keyed by the member name — the same
name the member's tool_use blocks carry. Every member is an
accepted key, and a member's defaults apply wherever its key is
absent. Unknown keys are rejected: the field set is this toolset
version's complete member set.
Per-member configuration for browser_toolset_20260801: one
optional field per member tool, keyed by the member name — the same
name the member's tool_use blocks carry. Every member is an
accepted key, and a member's defaults apply wherever its key is
absent. Unknown keys are rejected: the field set is this toolset
version's complete member set.
class BetaToolComputerUse20241022 { Type = "computer_20241022"; DisplayHeightPx; DisplayWidthPx; /* 7 more */ }
class BetaMemoryTool20250818 { Type = "memory_20250818"; Name; AllowedCallers; /* 4 more */ }
class BetaToolComputerUse20250124 { Type = "computer_20250124"; DisplayHeightPx; DisplayWidthPx; /* 7 more */ }
class BetaToolTextEditor20241022 { Type = "text_editor_20241022"; Name; AllowedCallers; /* 4 more */ }
class BetaToolComputerUse20251124 { Type = "computer_20251124"; DisplayHeightPx; DisplayWidthPx; /* 8 more */ }
class BetaComputerToolset20260801 { Type = "computer_toolset_20260801"; CacheControl; Configs; }The computer toolset: a single tools[] entry (carrying no
name) that declares the computer tool family. The model is
served the family's tool with any members disabled via configs
removed from its schema. Every member is enabled by default, zoom
included. The single-tool options display_number and
enable_zoom are not fields of a toolset entry — it carries only
type, configs, and cache_control; zoom is controlled
via configs.zoom.enabled.
The computer toolset: a single tools[] entry (carrying no
name) that declares the computer tool family. The model is
served the family's tool with any members disabled via configs
removed from its schema. Every member is enabled by default, zoom
included. The single-tool options display_number and
enable_zoom are not fields of a toolset entry — it carries only
type, configs, and cache_control; zoom is controlled
via configs.zoom.enabled.
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. See prompt caching pricing for details.
BetaComputerToolsetConfigs? ConfigsPer-member configuration for computer_toolset_20260801: one
optional field per member tool, keyed by the member name — the same
name the member's tool_use blocks carry. Every member is an
accepted key, and a member's defaults apply wherever its key is
absent. Unknown keys are rejected: the field set is this toolset
version's complete member set.
Per-member configuration for computer_toolset_20260801: one
optional field per member tool, keyed by the member name — the same
name the member's tool_use blocks carry. Every member is an
accepted key, and a member's defaults apply wherever its key is
absent. Unknown keys are rejected: the field set is this toolset
version's complete member set.
class BetaToolTextEditor20250124 { Type = "text_editor_20250124"; Name; AllowedCallers; /* 4 more */ }
class BetaToolTextEditor20250429 { Type = "text_editor_20250429"; Name; AllowedCallers; /* 4 more */ }
class BetaToolTextEditor20250728 { Type = "text_editor_20250728"; Name; AllowedCallers; /* 5 more */ }
class BetaWebSearchTool20250305 { Type = "web_search_20250305"; Name; AllowedCallers; /* 7 more */ }
class BetaWebFetchTool20250910 { Type = "web_fetch_20250910"; Name; AllowedCallers; /* 9 more */ }
class BetaWebSearchTool20260209 { Type = "web_search_20260209"; Name; AllowedCallers; /* 7 more */ }
class BetaWebFetchTool20260209 { Type = "web_fetch_20260209"; Name; AllowedCallers; /* 9 more */ }
class BetaWebFetchTool20260309 { Type = "web_fetch_20260309"; Name; AllowedCallers; /* 10 more */ }Web fetch tool with use_cache parameter for bypassing cached content.
Web fetch tool with use_cache parameter for bypassing cached content.
class BetaWebSearchTool20260318 { Type = "web_search_20260318"; Name; AllowedCallers; /* 8 more */ }
class BetaWebFetchTool20260318 { Type = "web_fetch_20260318"; Name; AllowedCallers; /* 11 more */ }
class BetaAdvisorTool20260301 { Type = "advisor_20260301"; Model; Name; /* 7 more */ }
class BetaToolSearchToolBm25_20251119 { Type; Name; AllowedCallers; /* 3 more */ }
class BetaToolSearchToolRegex20251119 { Type; Name; AllowedCallers; /* 3 more */ }
class BetaMcpToolset { Type = "mcp_toolset"; McpServerName; CacheControl; /* 2 more */ }Configuration for a group of tools from an MCP server.
Configuration for a group of tools from an MCP server.
Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides.
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.
Header param: The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the user-profiles beta header.
string workspaceIDHeader param: Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).
Header param: Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).
Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
BetaJsonOutputFormat? outputFormatDeprecatedBody 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.
Returns
class BetaMessageTokensCount { ContextManagement; InputTokens; }
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 = "Hello, world",
Role = Role.User,
ClearAt = ClearAt.NextUserMessage,
OutputConfig = new() { Effort = Effort.Low },
},
],
Model = Model.ClaudeOpus5,
};
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
}