Claude Platform Docs

Count tokens in a Message

client.Beta.Messages.CountTokens(ctx, params) (*BetaMessageTokensCount, error)
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 BetaMessageCountTokensParams
Messages param.Field[[]BetaMessageParamResp]

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.

One of the following:
One of the following:
type BetaTextBlockParamResp struct{…}
type BetaImageBlockParamResp struct{…}
type BetaRequestDocumentBlock struct{…}
type BetaSearchResultBlockParamResp struct{…}
type BetaThinkingBlockParamResp struct{…}
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
type BetaRedactedThinkingBlockParamResp struct{…}
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 RedactedThinking
type BetaToolUseBlockParamResp struct{…}
type BetaToolResultBlockParamResp struct{…}
type BetaServerToolUseBlockParamResp struct{…}
type BetaWebSearchToolResultBlockParamResp struct{…}
type BetaWebFetchToolResultBlockParamResp struct{…}
type BetaAdvisorToolResultBlockParamResp struct{…}
type BetaCodeExecutionToolResultBlockParamResp struct{…}

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

One of the following:
ToolUseID string
pattern^srvtoolu_[a-zA-Z0-9_]+$
Type CodeExecutionToolResult
CacheControl BetaCacheControlEphemeral Optional

Create a cache control breakpoint at this content block.

Type Ephemeral
TTL BetaCacheControlEphemeralTTL Optional

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:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaBashCodeExecutionToolResultBlockParamResp struct{…}
type BetaTextEditorCodeExecutionToolResultBlockParamResp struct{…}
type BetaToolSearchToolResultBlockParamResp struct{…}
type BetaMCPToolUseBlockParamResp struct{…}
ID string
pattern^[a-zA-Z0-9_-]+$
Input map[string, any]
Name string
ServerName string

The name of the MCP server

Type MCPToolUse
CacheControl BetaCacheControlEphemeral Optional

Create a cache control breakpoint at this content block.

Type Ephemeral
TTL BetaCacheControlEphemeralTTL Optional

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:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaRequestMCPToolResultBlockParamResp struct{…}
type BetaContainerUploadBlockParamResp struct{…}

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.

FileID string
Type ContainerUpload
CacheControl BetaCacheControlEphemeral Optional

Create a cache control breakpoint at this content block.

Type Ephemeral
TTL BetaCacheControlEphemeralTTL Optional

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:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaCompactionBlockParamResp struct{…}

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
CacheControl BetaCacheControlEphemeral Optional

Create a cache control breakpoint at this content block.

Type Ephemeral
TTL BetaCacheControlEphemeralTTL Optional

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:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Content string Optional

Summary of previously compacted content, or null if compaction failed

EncryptedContent string Optional

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

type BetaRequestToolAdditionBlock struct{…}

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.

type BetaRequestToolRemovalBlock struct{…}

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.

type BetaFallbackBlockParamResp struct{…}

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.

Identifies one hop of a fallback transition.

Model Model

The model that will complete your prompt.

See models for additional details and options.

One of the following:

Identifies one hop of a fallback transition.

Model Model

The model that will complete your prompt.

See models for additional details and options.

One of the following:
Type Fallback
Trigger any Optional

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

Role BetaMessageParamRole
One of the following:
const BetaMessageParamRoleUser BetaMessageParamRole = "user"
const BetaMessageParamRoleAssistant BetaMessageParamRole = "assistant"
const BetaMessageParamRoleSystem BetaMessageParamRole = "system"
Model param.Field[Model]

Body param: The model that will complete your prompt.

See models for additional details and options.

CacheControl param.Field[BetaCacheControlEphemeral] Optional

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

ContextManagement param.Field[BetaContextManagementConfig] Optional

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.

MCPServers param.Field[[]BetaRequestMCPServerURLDefinition] Optional

Body param: MCP servers to be utilized in this request

maxItems20
Name string
Type URL
URL string
AuthorizationToken string Optional
ToolConfiguration BetaRequestMCPServerToolConfiguration Optional
AllowedTools []string Optional
Enabled bool Optional
OutputConfig param.Field[BetaOutputConfig] Optional

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

Speed param.Field[BetaMessageCountTokensParamsSpeed] Optional

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.

const BetaMessageCountTokensParamsSpeedStandard BetaMessageCountTokensParamsSpeed = "standard"
const BetaMessageCountTokensParamsSpeedFast BetaMessageCountTokensParamsSpeed = "fast"
System param.Field[BetaMessageCountTokensParamsSystemUnion] Optional

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.

string
type BetaMessageCountTokensParamsSystemArray []BetaTextBlockParamResp
Text string
minLength1
Type Text
CacheControl BetaCacheControlEphemeral Optional

Create a cache control breakpoint at this content block.

Type Ephemeral
TTL BetaCacheControlEphemeralTTL Optional

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:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Citations []BetaTextCitationParamUnionResp Optional
One of the following:
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
minimum0
DocumentTitle string
maxLength500
minLength1
EndCharIndex int64
StartCharIndex int64
minimum0
Type CharLocation
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
minimum0
DocumentTitle string
maxLength500
minLength1
EndPageNumber int64
StartPageNumber int64
minimum1
Type PageLocation
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText 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.

DocumentIndex int64
minimum0
DocumentTitle string
maxLength500
minLength1
EndBlockIndex int64

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.

StartBlockIndex int64

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

minimum0
Type ContentBlockLocation
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
maxLength512
minLength1
Type WebSearchResultLocation
URL string
minLength1
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText 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.

EndBlockIndex int64

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.

SearchResultIndex int64

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
StartBlockIndex int64

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

minimum0
Title string
Type SearchResultLocation
Thinking param.Field[BetaThinkingConfigParamUnionResp] Optional

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.

ToolChoice param.Field[BetaToolChoiceUnion] Optional

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.

Tools param.Field[[]BetaMessageCountTokensParamsToolUnion] Optional

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.

type BetaTool struct{…}
type BetaToolBash20241022 struct{…}
type BetaToolBash20250124 struct{…}
type BetaCodeExecutionTool20250522 struct{…}
type BetaCodeExecutionTool20250825 struct{…}
type BetaCodeExecutionTool20260120 struct{…}

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

type BetaCodeExecutionTool20260521 struct{…}

Code execution tool with REPL state persistence.

type BetaBrowserToolset20260801 struct{…}

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.

type BetaToolComputerUse20241022 struct{…}
type BetaMemoryTool20250818 struct{…}
type BetaToolComputerUse20250124 struct{…}
type BetaToolTextEditor20241022 struct{…}
type BetaToolComputerUse20251124 struct{…}
type BetaComputerToolset20260801 struct{…}

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.

type BetaToolTextEditor20250124 struct{…}
type BetaToolTextEditor20250429 struct{…}
type BetaToolTextEditor20250728 struct{…}
type BetaWebSearchTool20250305 struct{…}
type BetaWebFetchTool20250910 struct{…}
type BetaWebSearchTool20260209 struct{…}
type BetaWebFetchTool20260209 struct{…}
type BetaWebFetchTool20260309 struct{…}

Web fetch tool with use_cache parameter for bypassing cached content.

type BetaWebSearchTool20260318 struct{…}
type BetaWebFetchTool20260318 struct{…}
type BetaAdvisorTool20260301 struct{…}
type BetaToolSearchToolBm25_20251119 struct{…}
type BetaToolSearchToolRegex20251119 struct{…}
type BetaMCPToolset struct{…}

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 param.Field[[]AnthropicBeta] Optional

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

string
type AnthropicBeta string
One of the following:
const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"
const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"
const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"
const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"
const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"
const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"
const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"
const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"
const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"
const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"
const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"
const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"
const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"
const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"
const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"
const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"
const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"
const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"
const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"
const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"
const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"
const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"
const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"
const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"
const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"
const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"
const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"
const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"
const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"
const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"
const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"
const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"
const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"
const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"
const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"
const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"
const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"
const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"
const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"
const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"
const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"
UserProfileID param.Field[string] Optional

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.

OutputFormat param.Field[BetaJSONOutputFormat] OptionalDeprecated

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
type BetaMessageTokensCount struct{…}

Information about context management applied to the message.

OriginalInputTokens int64

The original token count before context management was applied

InputTokens int64

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

Count tokens in a Message

package main

import (
	"context"
	"fmt"

	"github.com/anthropics/anthropic-sdk-go"
	"github.com/anthropics/anthropic-sdk-go/option"
)

func main() {
	client := anthropic.NewClient(
		option.WithAPIKey("my-anthropic-api-key"),
	)
	betaMessageTokensCount, err := client.Beta.Messages.CountTokens(context.TODO(), anthropic.BetaMessageCountTokensParams{
		Messages: []anthropic.BetaMessageParam{anthropic.BetaMessageParam{
			Content: []anthropic.BetaContentBlockParamUnion{anthropic.BetaContentBlockParamUnion{
				OfText: &anthropic.BetaTextBlockParam{
					Text: "x",
				},
			}},
			Role: anthropic.BetaMessageParamRoleUser,
		}},
		Model: anthropic.ModelClaudeOpus5,
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", betaMessageTokensCount.ContextManagement)
}
{
  "context_management": {
    "original_input_tokens": 0
  },
  "input_tokens": 2095
}
Returns Examples
{
  "context_management": {
    "original_input_tokens": 0
  },
  "input_tokens": 2095
}