Claude Platform Docs

Count tokens in a Message

client.beta.messages.countTokens(MessageCountTokensParamsparams, RequestOptionsoptions?): BetaMessageTokensCount
POST/v1/messages/count_tokens

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

Parameters
params: MessageCountTokensParams { messages, model, cache_control, 11 more }
messages: Array<BetaMessageParam { content, role }>

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.

content: string | Array<BetaContentBlockParam>
One of the following:
string
BetaTextBlockParam { text, type, cache_control, citations }
BetaImageBlockParam { source, type, cache_control, transformations }
BetaRequestDocumentBlock { source, type, cache_control, 3 more }
BetaSearchResultBlockParam { content, source, title, 3 more }
BetaThinkingBlockParam { signature, thinking, type }
signature: string

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.

thinking: string

The thinking text of this block as returned by the API.

type: "thinking"
BetaRedactedThinkingBlockParam { data, type }
data: string

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.

type: "redacted_thinking"
BetaToolUseBlockParam { id, input, name, 4 more }
BetaToolResultBlockParam { tool_use_id, type, cache_control, 3 more }
BetaServerToolUseBlockParam { id, input, name, 3 more }
BetaWebSearchToolResultBlockParam { content, tool_use_id, type, 2 more }
BetaWebFetchToolResultBlockParam { content, tool_use_id, type, 2 more }
BetaAdvisorToolResultBlockParam { content, tool_use_id, type, cache_control }
BetaCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }

Code execution result with encrypted stdout for PFC + web_search results.

One of the following:
tool_use_id: string
pattern^srvtoolu_[a-zA-Z0-9_]+$
type: "code_execution_tool_result"
cache_control?: BetaCacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"
ttl?: "5m" | "1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

  • 5m: 5 minutes
  • 1h: 1 hour

Defaults to 5m. See prompt caching pricing for details.

One of the following:
"5m"
"1h"
BetaBashCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }
BetaTextEditorCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }
BetaToolSearchToolResultBlockParam { content, tool_use_id, type, cache_control }
BetaMCPToolUseBlockParam { id, input, name, 3 more }
id: string
pattern^[a-zA-Z0-9_-]+$
input: Record<string, unknown>
name: string
server_name: string

The name of the MCP server

type: "mcp_tool_use"
cache_control?: BetaCacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"
ttl?: "5m" | "1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

  • 5m: 5 minutes
  • 1h: 1 hour

Defaults to 5m. See prompt caching pricing for details.

One of the following:
"5m"
"1h"
BetaRequestMCPToolResultBlockParam { tool_use_id, type, cache_control, 2 more }
BetaContainerUploadBlockParam { file_id, type, cache_control }

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.

file_id: string
type: "container_upload"
cache_control?: BetaCacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"
ttl?: "5m" | "1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

  • 5m: 5 minutes
  • 1h: 1 hour

Defaults to 5m. See prompt caching pricing for details.

One of the following:
"5m"
"1h"
BetaCompactionBlockParam { type, cache_control, content, encrypted_content }

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.

type: "compaction"
cache_control?: BetaCacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"
ttl?: "5m" | "1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

  • 5m: 5 minutes
  • 1h: 1 hour

Defaults to 5m. See prompt caching pricing for details.

One of the following:
"5m"
"1h"
content?: string | null

Summary of previously compacted content, or null if compaction failed

encrypted_content?: string | null

Opaque metadata from prior compaction, to be round-tripped verbatim

BetaRequestToolAdditionBlock { tool, type, cache_control }

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.

BetaRequestToolRemovalBlock { tool, type, cache_control }

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.

BetaFallbackBlockParam { from, to, type, trigger }

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.

from: BetaFallbackInfoParam { model }

Identifies one hop of a fallback transition.

to: BetaFallbackInfoParam { model }

Identifies one hop of a fallback transition.

type: "fallback"
trigger?: unknown

The response block's trigger, echoed verbatim. Accepted and ignored by the server; any object or null is allowed.

role: "user" | "assistant" | "system"
One of the following:
"user"
"assistant"
"system"
model: Model

Body param: The model that will complete your prompt.

See models for additional details and options.

One of the following:
"claude-sonnet-5" | "claude-fable-5" | "claude-mythos-5" | 12 more
"claude-sonnet-5"

High-performance model for coding and agents

"claude-fable-5"

Next generation of intelligence for the hardest knowledge work and coding problems

"claude-mythos-5"

Most capable model for cybersecurity and biology research

"claude-opus-5"

Powerful intelligence for long-running agents and coding

"claude-opus-4-8"

Powerful intelligence for long-running agents and coding

"claude-opus-4-7"

Powerful intelligence for long-running agents and coding

"claude-mythos-preview"

New class of intelligence, strongest in coding and cybersecurity

"claude-opus-4-6"

Powerful intelligence for long-running agents and coding

"claude-sonnet-4-6"

Best combination of speed and intelligence

"claude-haiku-4-5"

Fastest model with near-frontier intelligence

"claude-haiku-4-5-20251001"

Fastest model with near-frontier intelligence

"claude-opus-4-5"

Powerful intelligence for long-running agents and coding

"claude-opus-4-5-20251101"

Powerful intelligence for long-running agents and coding

"claude-sonnet-4-5"

High-performance model for agents and coding

"claude-sonnet-4-5-20250929"

High-performance model for agents and coding

(string & {})
cache_control?: BetaCacheControlEphemeral { type, ttl } | null

Body param: Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request.

type: "ephemeral"
ttl?: "5m" | "1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

  • 5m: 5 minutes
  • 1h: 1 hour

Defaults to 5m. See prompt caching pricing for details.

One of the following:
"5m"
"1h"
context_management?: BetaContextManagementConfig { edits } | null

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.

mcp_servers?: Array<BetaRequestMCPServerURLDefinition { name, type, url, 2 more }>

Body param: MCP servers to be utilized in this request

maxItems20
name: string
type: "url"
url: string
authorization_token?: string | null
tool_configuration?: BetaRequestMCPServerToolConfiguration { allowed_tools, enabled } | null
allowed_tools?: Array<string> | null
enabled?: boolean | null
output_config?: BetaOutputConfig { effort, format, task_budget }

Body param: Configuration options for the model's output, such as the output format.

speed?: "standard" | "fast" | null

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.

One of the following:
"standard"
"fast"
system?: string | Array<BetaTextBlockParam { text, type, cache_control, citations }>

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.

One of the following:
string
Array<BetaTextBlockParam { text, type, cache_control, citations }>
text: string
minLength1
type: "text"
cache_control?: BetaCacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"
ttl?: "5m" | "1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

  • 5m: 5 minutes
  • 1h: 1 hour

Defaults to 5m. See prompt caching pricing for details.

One of the following:
"5m"
"1h"
citations?: Array<BetaTextCitationParam> | null
One of the following:
BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string | null
maxLength500
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string | null
maxLength500
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
cited_text: string

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.

document_index: number
minimum0
document_title: string | null
maxLength500
minLength1
end_block_index: number

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.

start_block_index: number

0-based index of the first cited block in the source's content array.

minimum0
type: "content_block_location"
BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string | null
maxLength512
minLength1
type: "web_search_result_location"
url: string
minLength1
BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string

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.

end_block_index: number

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.

search_result_index: number

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.

minimum0
source: string
start_block_index: number

0-based index of the first cited block in the source's content array.

minimum0
title: string | null
type: "search_result_location"

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.

One of the following:
tool_choice?: BetaToolChoice

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.

One of the following:
tools?: Array<BetaTool { input_schema, name, allowed_callers, 7 more } | BetaToolBash20241022 { name, type, allowed_callers, 4 more } | BetaToolBash20250124 { name, type, allowed_callers, 4 more } | 25 more>

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 tool input shape that the model will produce in tool_use output content blocks.

For example, if you defined tools as:

[
  {
    "name": "get_stock_price",
    "description": "Get the current stock price for a given ticker symbol.",
    "input_schema": {
      "type": "object",
      "properties": {
        "ticker": {
          "type": "string",
          "description": "The stock ticker symbol, e.g. AAPL for Apple Inc."
        }
      },
      "required": ["ticker"]
    }
  }
]

And then asked the model "What's the S&P 500 at today?", the model might produce tool_use content blocks in the response like this:

[
  {
    "type": "tool_use",
    "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
    "name": "get_stock_price",
    "input": { "ticker": "^GSPC" }
  }
]

You might then run your get_stock_price tool with {"ticker": "^GSPC"} as an input, and return the following back to the model in a subsequent user message:

[
  {
    "type": "tool_result",
    "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
    "content": "259.75 USD"
  }
]

Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output.

See our guide for more details.

One of the following:
BetaTool { input_schema, name, allowed_callers, 7 more }
BetaToolBash20241022 { name, type, allowed_callers, 4 more }
BetaToolBash20250124 { name, type, allowed_callers, 4 more }
BetaCodeExecutionTool20250522 { name, type, allowed_callers, 3 more }
BetaCodeExecutionTool20250825 { name, type, allowed_callers, 3 more }
BetaCodeExecutionTool20260120 { name, type, allowed_callers, 3 more }

Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).

BetaCodeExecutionTool20260521 { name, type, allowed_callers, 3 more }

Code execution tool with REPL state persistence.

BetaBrowserToolset20260801 { type, allowed_callers, cache_control, 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.

BetaToolComputerUse20241022 { display_height_px, display_width_px, name, 7 more }
BetaMemoryTool20250818 { name, type, allowed_callers, 4 more }
BetaToolComputerUse20250124 { display_height_px, display_width_px, name, 7 more }
BetaToolTextEditor20241022 { name, type, allowed_callers, 4 more }
BetaToolComputerUse20251124 { display_height_px, display_width_px, name, 8 more }
BetaComputerToolset20260801 { type, allowed_callers, cache_control, 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.

BetaToolTextEditor20250124 { name, type, allowed_callers, 4 more }
BetaToolTextEditor20250429 { name, type, allowed_callers, 4 more }
BetaToolTextEditor20250728 { name, type, allowed_callers, 5 more }
BetaWebSearchTool20250305 { name, type, allowed_callers, 7 more }
BetaWebFetchTool20250910 { name, type, allowed_callers, 8 more }
BetaWebSearchTool20260209 { name, type, allowed_callers, 7 more }
BetaWebFetchTool20260209 { name, type, allowed_callers, 8 more }
BetaWebFetchTool20260309 { name, type, allowed_callers, 9 more }

Web fetch tool with use_cache parameter for bypassing cached content.

BetaWebSearchTool20260318 { name, type, allowed_callers, 8 more }
BetaWebFetchTool20260318 { name, type, allowed_callers, 10 more }
BetaAdvisorTool20260301 { model, name, type, 7 more }
BetaToolSearchToolBm25_20251119 { name, type, allowed_callers, 3 more }
BetaToolSearchToolRegex20251119 { name, type, allowed_callers, 3 more }
BetaMCPToolset { mcp_server_name, type, cache_control, 2 more }

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.

betas?: Array<AnthropicBeta>

Header param: Optional header to specify the beta version(s) you want to use.

One of the following:
(string & {})
"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
user_profile_id?: string

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.

output_format?: BetaJSONOutputFormat { schema, type } | nullDeprecated

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.

schema: Record<string, unknown>

The JSON schema of the format

type: "json_schema"
Returns
BetaMessageTokensCount { context_management, input_tokens }
context_management: BetaCountTokensContextManagementResponse { original_input_tokens } | null

Information about context management applied to the message.

original_input_tokens: number

The original token count before context management was applied

input_tokens: number

The total number of tokens across the provided list of messages, system prompt, and tools.

Count tokens in a Message

import Anthropic from "@anthropic-ai/sdk";

const client = new Anthropic({
  apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted
});

const betaMessageTokensCount = await client.beta.messages.countTokens({
  messages: [{ content: "Hello, world", role: "user" }],
  model: "claude-opus-5"
});

console.log(betaMessageTokensCount.context_management);
{
  "context_management": {
    "original_input_tokens": 0
  },
  "input_tokens": 2095
}
Returns Examples
{
  "context_management": {
    "original_input_tokens": 0
  },
  "input_tokens": 2095
}