Claude Platform Docs

Count tokens in a Message

client.Messages.CountTokens(ctx, params) (*MessageTokensCount, 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 MessageCountTokensParams
Messages param.Field[[]MessageParamResp]

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 TextBlockParamResp struct{…}
type ImageBlockParamResp struct{…}
type DocumentBlockParamResp struct{…}
type SearchResultBlockParamResp struct{…}
type ThinkingBlockParamResp 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 RedactedThinkingBlockParamResp 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 ToolUseBlockParamResp struct{…}
type ToolResultBlockParamResp struct{…}
type ServerToolUseBlockParamResp struct{…}
type WebSearchToolResultBlockParamResp struct{…}
type WebFetchToolResultBlockParamResp struct{…}
type CodeExecutionToolResultBlockParamResp 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 CacheControlEphemeral Optional

Create a cache control breakpoint at this content block.

Type Ephemeral
TTL CacheControlEphemeralTTL 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 CacheControlEphemeralTTLTTL5m CacheControlEphemeralTTL = "5m"
const CacheControlEphemeralTTLTTL1h CacheControlEphemeralTTL = "1h"
type BashCodeExecutionToolResultBlockParamResp struct{…}
type TextEditorCodeExecutionToolResultBlockParamResp struct{…}
type ToolSearchToolResultBlockParamResp struct{…}
type ContainerUploadBlockParamResp 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 CacheControlEphemeral Optional

Create a cache control breakpoint at this content block.

Type Ephemeral
TTL CacheControlEphemeralTTL 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 CacheControlEphemeralTTLTTL5m CacheControlEphemeralTTL = "5m"
const CacheControlEphemeralTTLTTL1h CacheControlEphemeralTTL = "1h"
Role MessageParamRole
One of the following:
const MessageParamRoleUser MessageParamRole = "user"
const MessageParamRoleAssistant MessageParamRole = "assistant"
const MessageParamRoleSystem MessageParamRole = "system"
Model param.Field[Model]

Body param: The model that will complete your prompt.

See models for additional details and options.

CacheControl param.Field[CacheControlEphemeral] Optional

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

OutputConfig param.Field[OutputConfig] Optional

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

System param.Field[MessageCountTokensParamsSystemUnion] 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 MessageCountTokensParamsSystemArray []TextBlockParamResp
Text string
minLength1
Type Text
CacheControl CacheControlEphemeral Optional

Create a cache control breakpoint at this content block.

Type Ephemeral
TTL CacheControlEphemeralTTL 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 CacheControlEphemeralTTLTTL5m CacheControlEphemeralTTL = "5m"
const CacheControlEphemeralTTLTTL1h CacheControlEphemeralTTL = "1h"
Citations []TextCitationParamUnionResp Optional
One of the following:
type CitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
minimum0
DocumentTitle string
maxLength500
minLength1
EndCharIndex int64
StartCharIndex int64
minimum0
Type CharLocation
type CitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
minimum0
DocumentTitle string
maxLength500
minLength1
EndPageNumber int64
StartPageNumber int64
minimum1
Type PageLocation
type CitationContentBlockLocationParamResp 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 CitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
maxLength512
minLength1
Type WebSearchResultLocation
URL string
minLength1
type CitationSearchResultLocationParamResp 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[ThinkingConfigParamUnionResp] 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[ToolChoiceUnion] 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[[]MessageCountTokensToolUnion] 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 Tool struct{…}
type ToolBash20250124 struct{…}
type CodeExecutionTool20250522 struct{…}
type CodeExecutionTool20250825 struct{…}
type CodeExecutionTool20260120 struct{…}

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

type CodeExecutionTool20260521 struct{…}

Code execution tool with REPL state persistence.

type BrowserToolset20260801 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 BrowserToolset20260801
AllowedCallers []string Optional
One of the following:
const BrowserToolset20260801AllowedCallerDirect BrowserToolset20260801AllowedCaller = "direct"
const BrowserToolset20260801AllowedCallerCodeExecution20250825 BrowserToolset20260801AllowedCaller = "code_execution_20250825"
const BrowserToolset20260801AllowedCallerCodeExecution20260120 BrowserToolset20260801AllowedCaller = "code_execution_20260120"
const BrowserToolset20260801AllowedCallerCodeExecution20260521 BrowserToolset20260801AllowedCaller = "code_execution_20260521"
CacheControl CacheControlEphemeral Optional

Create a cache control breakpoint at this content block.

Type Ephemeral
TTL CacheControlEphemeralTTL 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 CacheControlEphemeralTTLTTL5m CacheControlEphemeralTTL = "5m"
const CacheControlEphemeralTTLTTL1h CacheControlEphemeralTTL = "1h"
Configs BrowserToolsetConfigs Optional

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.

type MemoryTool20250818 struct{…}
type ComputerToolset20260801 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 ToolTextEditor20250124 struct{…}
type ToolTextEditor20250429 struct{…}
type ToolTextEditor20250728 struct{…}
type WebSearchTool20250305 struct{…}
type WebFetchTool20250910 struct{…}
type WebSearchTool20260209 struct{…}
type WebFetchTool20260209 struct{…}
type WebFetchTool20260309 struct{…}

Web fetch tool with use_cache parameter for bypassing cached content.

type WebSearchTool20260318 struct{…}
type WebFetchTool20260318 struct{…}
type ToolSearchToolBm25_20251119 struct{…}
type ToolSearchToolRegex20251119 struct{…}
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.

Returns
type MessageTokensCount struct{…}
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"),
	)
	messageTokensCount, err := client.Messages.CountTokens(context.TODO(), anthropic.MessageCountTokensParams{
		Messages: []anthropic.MessageParam{anthropic.MessageParam{
			Content: []anthropic.ContentBlockParamUnion{anthropic.ContentBlockParamUnion{
				OfText: &anthropic.TextBlockParam{
					Text: "x",
				},
			}},
			Role: anthropic.MessageParamRoleUser,
		}},
		Model: anthropic.ModelClaudeOpus5,
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", messageTokensCount.InputTokens)
}
{
  "input_tokens": 2095
}
Returns Examples
{
  "input_tokens": 2095
}