Create a Message
Send a structured list of input messages with text and/or image content, and the model will generate the next message in the conversation.
The Messages API can be used for either single queries or stateless multi-turn conversations.
Learn more about the Messages API in our user guide
ParametersExpand Collapse
MessageCreateParams params
Optional<List<AnthropicBeta>> betasOptional header to specify the beta version(s) you want to use.
Optional header to specify the beta version(s) you want to use.
long maxTokensThe maximum number of tokens to generate before stopping.
The maximum number of tokens to generate before stopping.
Note that our models may stop before reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate.
Different models have different maximum values for this parameter. See models for details.
List<BetaMessageParam> messagesInput messages.
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 content
List<BetaContentBlockParam>
class BetaTextBlockParam:
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
Optional<List<BetaTextCitationParam>> citations
class BetaCitationCharLocationParam:
class BetaCitationPageLocationParam:
class BetaCitationContentBlockLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationSearchResultLocationParam:
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
class BetaUrlImageSource:
class BetaFileImageSource:
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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:
Source source
class BetaBase64PdfSource:
class BetaPlainTextSource:
class BetaContentBlockSource:
Content content
class BetaTextBlockParam:
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
Optional<List<BetaTextCitationParam>> citations
class BetaCitationCharLocationParam:
class BetaCitationPageLocationParam:
class BetaCitationContentBlockLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationSearchResultLocationParam:
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
class BetaUrlImageSource:
class BetaFileImageSource:
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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:
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
Optional<BetaCitationsConfigParam> citations
class BetaSearchResultBlockParam:
List<BetaTextBlockParam> content
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
Optional<List<BetaTextCitationParam>> citations
class BetaCitationCharLocationParam:
class BetaCitationPageLocationParam:
class BetaCitationContentBlockLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationSearchResultLocationParam:
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
Optional<BetaCitationsConfigParam> citations
class BetaThinkingBlockParam:
class BetaRedactedThinkingBlockParam:
class BetaToolUseBlockParam:
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
Optional<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:
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
Optional<Content> content
List<Block>
class BetaTextBlockParam:
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
Optional<List<BetaTextCitationParam>> citations
class BetaCitationCharLocationParam:
class BetaCitationPageLocationParam:
class BetaCitationContentBlockLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationSearchResultLocationParam:
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
class BetaUrlImageSource:
class BetaFileImageSource:
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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:
List<BetaTextBlockParam> content
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
Optional<List<BetaTextCitationParam>> citations
class BetaCitationCharLocationParam:
class BetaCitationPageLocationParam:
class BetaCitationContentBlockLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationSearchResultLocationParam:
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
Optional<BetaCitationsConfigParam> citations
class BetaRequestDocumentBlock:
Source source
class BetaBase64PdfSource:
class BetaPlainTextSource:
class BetaContentBlockSource:
Content content
class BetaTextBlockParam:
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
Optional<List<BetaTextCitationParam>> citations
class BetaCitationCharLocationParam:
class BetaCitationPageLocationParam:
class BetaCitationContentBlockLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationSearchResultLocationParam:
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
class BetaUrlImageSource:
class BetaFileImageSource:
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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:
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
Optional<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.
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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:
Name name
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
Optional<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:
class BetaWebSearchToolRequestError:
BetaWebSearchToolResultErrorCode errorCode
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
Optional<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:
Content content
class BetaWebFetchToolResultErrorBlockParam:
BetaWebFetchToolResultErrorCode errorCode
class BetaWebFetchBlockParam:
BetaRequestDocumentBlock content
Source source
class BetaBase64PdfSource:
class BetaPlainTextSource:
class BetaContentBlockSource:
Content content
class BetaTextBlockParam:
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
Optional<List<BetaTextCitationParam>> citations
class BetaCitationCharLocationParam:
class BetaCitationPageLocationParam:
class BetaCitationContentBlockLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationSearchResultLocationParam:
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
class BetaUrlImageSource:
class BetaFileImageSource:
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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:
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
Optional<BetaCitationsConfigParam> citations
Fetched content URL
ISO 8601 timestamp when the content was retrieved
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
Optional<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:
Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
class BetaCodeExecutionToolResultErrorParam:
BetaCodeExecutionToolResultErrorCode errorCode
class BetaCodeExecutionResultBlockParam:
List<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.
List<BetaCodeExecutionOutputBlockParam> content
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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:
Content content
class BetaBashCodeExecutionToolResultErrorParam:
ErrorCode errorCode
class BetaBashCodeExecutionResultBlockParam:
List<BetaBashCodeExecutionOutputBlockParam> content
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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:
Content content
class BetaTextEditorCodeExecutionToolResultErrorParam:
ErrorCode errorCode
class BetaTextEditorCodeExecutionViewResultBlockParam:
FileType fileType
class BetaTextEditorCodeExecutionCreateResultBlockParam:
class BetaTextEditorCodeExecutionStrReplaceResultBlockParam:
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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:
Content content
class BetaToolSearchToolResultErrorParam:
ErrorCode errorCode
class BetaToolSearchToolSearchResultBlockParam:
List<BetaToolReferenceBlockParam> toolReferences
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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:
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
Optional<Content> content
List<BetaTextBlockParam>
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
Optional<List<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.
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
Role role
Model modelThe model that will complete your prompt.
The model that will complete your prompt.
See models for additional details and options.
Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request.
Optional<Container> containerContainer identifier for reuse across requests.
Container identifier for reuse across requests.
class BetaContainerParams:Container parameters with skills to be loaded.
Container parameters with skills to be loaded.
Container id
Optional<List<BetaSkillParams>> skillsList of skills to load in the container
List of skills to load in the container
Skill ID
Type typeType of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Skill version or 'latest' for most recent version
Optional<BetaContextManagementConfig> contextManagementContext management configuration.
Context management configuration.
This allows you to control how Claude manages context across multiple requests, such as whether to clear function results or not.
Specifies the geographic region for inference processing. If not specified, the workspace's default_inference_geo is used.
Optional<List<BetaRequestMcpServerUrlDefinition>> mcpServersMCP servers to be utilized in this request
MCP servers to be utilized in this request
Optional<BetaRequestMcpServerToolConfiguration> toolConfiguration
An object describing metadata about the request.
Configuration options for the model's output, such as the output format.
DeprecatedOptional<BetaJsonOutputFormat> outputFormatDeprecated: Use output_config.format instead. See structured outputs
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.
Optional<ServiceTier> serviceTierDetermines whether to use priority capacity (if available) or standard capacity for this request.
Determines whether to use priority capacity (if available) or standard capacity for this request.
Anthropic offers different levels of service for your API requests. See service-tiers for details.
Optional<Speed> speedThe inference speed mode for this request. "fast" enables high output-tokens-per-second inference.
The inference speed mode for this request. "fast" enables high output-tokens-per-second inference.
Optional<List<String>> stopSequencesCustom text sequences that will cause the model to stop generating.
Custom text sequences that will cause the model to stop generating.
Our models will normally stop when they have naturally completed their turn, which will result in a response stop_reason of "end_turn".
If you want the model to stop generating when it encounters custom strings of text, you can use the stop_sequences parameter. If the model encounters one of the custom sequences, the response stop_reason value will be "stop_sequence" and the response stop_sequence value will contain the matched stop sequence.
Optional<System> systemSystem prompt.
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.
List<BetaTextBlockParam>
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
Optional<List<BetaTextCitationParam>> citations
class BetaCitationCharLocationParam:
class BetaCitationPageLocationParam:
class BetaCitationContentBlockLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationSearchResultLocationParam:
Optional<Double> temperatureAmount of randomness injected into the response.
Amount of randomness injected into the response.
Defaults to 1.0. Ranges from 0.0 to 1.0. Use temperature closer to 0.0 for analytical / multiple choice, and closer to 1.0 for creative and generative tasks.
Note that even with temperature of 0.0, the results will not be fully deterministic.
Optional<BetaThinkingConfigParam> thinkingConfiguration for enabling Claude's extended thinking.
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.
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.
Optional<List<BetaToolUnion>> toolsDefinitions of tools that the model may use.
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:
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.
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.
Optional<List<AllowedCaller>> allowedCallers
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
Optional<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:
JsonValue; name "bash"constant"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.
Optional<List<AllowedCaller>> allowedCallers
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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:
JsonValue; name "bash"constant"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.
Optional<List<AllowedCaller>> allowedCallers
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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:
JsonValue; name "code_execution"constant"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.
Optional<List<AllowedCaller>> allowedCallers
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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:
JsonValue; name "code_execution"constant"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.
Optional<List<AllowedCaller>> allowedCallers
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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).
JsonValue; name "code_execution"constant"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.
Optional<List<AllowedCaller>> allowedCallers
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
JsonValue; name "computer"constant"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.
Optional<List<AllowedCaller>> allowedCallers
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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:
JsonValue; name "memory"constant"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.
Optional<List<AllowedCaller>> allowedCallers
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
JsonValue; name "computer"constant"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.
Optional<List<AllowedCaller>> allowedCallers
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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:
JsonValue; name "str_replace_editor"constant"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.
Optional<List<AllowedCaller>> allowedCallers
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
JsonValue; name "computer"constant"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.
Optional<List<AllowedCaller>> allowedCallers
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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:
JsonValue; name "str_replace_editor"constant"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.
Optional<List<AllowedCaller>> allowedCallers
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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:
JsonValue; name "str_replace_based_edit_tool"constant"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.
Optional<List<AllowedCaller>> allowedCallers
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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:
JsonValue; name "str_replace_based_edit_tool"constant"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.
Optional<List<AllowedCaller>> allowedCallers
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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:
JsonValue; name "web_search"constant"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.
Optional<List<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.
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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
Optional<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:
JsonValue; name "web_fetch"constant"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.
Optional<List<AllowedCaller>> allowedCallers
List of domains to allow fetching from
List of domains to block fetching from
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
Optional<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:
JsonValue; name "web_search"constant"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.
Optional<List<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.
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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
Optional<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:
JsonValue; name "web_fetch"constant"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.
Optional<List<AllowedCaller>> allowedCallers
List of domains to allow fetching from
List of domains to block fetching from
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
Optional<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:
JsonValue; name "tool_search_tool_bm25"constant"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.
Type type
Optional<List<AllowedCaller>> allowedCallers
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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:
JsonValue; name "tool_search_tool_regex"constant"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.
Type type
Optional<List<AllowedCaller>> allowedCallers
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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
Optional<BetaCacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<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.
Optional<Configs> configsConfiguration overrides for specific tools, keyed by tool name
Configuration overrides for specific tools, keyed by tool name
Optional<BetaMcpToolDefaultConfig> defaultConfigDefault configuration applied to all tools from this server
Default configuration applied to all tools from this server
Optional<Long> topKOnly sample from the top K options for each subsequent token.
Only sample from the top K options for each subsequent token.
Used to remove "long tail" low probability responses. Learn more technical details here.
Recommended for advanced use cases only. You usually only need to use temperature.
Optional<Double> topPUse nucleus sampling.
Use nucleus sampling.
In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by top_p. You should either alter temperature or top_p, but not both.
Recommended for advanced use cases only. You usually only need to use temperature.
ReturnsExpand Collapse
class BetaMessage:
String idUnique object identifier.
Unique object identifier.
The format and length of IDs may change over time.
Optional<BetaContainer> containerInformation about the container used in the request (for the code execution tool)
Information about the container used in the request (for the code execution tool)
Identifier for the container used in this request
The time at which the container will expire.
Optional<List<BetaSkill>> skillsSkills loaded in the container
Skills loaded in the container
Skill ID
Type typeType of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Skill version or 'latest' for most recent version
List<BetaContentBlock> contentContent generated by the model.
Content generated by the model.
This is an array of content blocks, each of which has a type that determines its shape.
Example:
[{"type": "text", "text": "Hi, I'm Claude."}]
If the request input messages ended with an assistant turn, then the response content will continue directly from that last turn. You can use this to constrain the model's output.
For example, if the input messages were:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("}
]
Then the response content might be:
[{"type": "text", "text": "B)"}]
class BetaTextBlock:
Optional<List<BetaTextCitation>> citationsCitations supporting the text block.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaThinkingBlock:
class BetaRedactedThinkingBlock:
class BetaToolUseBlock:
Optional<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 BetaServerToolUseBlock:
Name name
Optional<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 BetaWebSearchToolResultBlock:
class BetaWebSearchToolResultError:
BetaWebSearchToolResultErrorCode errorCode
List<BetaWebSearchResultBlock>
Optional<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 BetaWebFetchToolResultBlock:
Content content
class BetaWebFetchToolResultErrorBlock:
BetaWebFetchToolResultErrorCode errorCode
class BetaWebFetchBlock:
BetaDocumentBlock content
Optional<BetaCitationConfig> citationsCitation configuration for the document
Citation configuration for the document
Source source
class BetaBase64PdfSource:
class BetaPlainTextSource:
The title of the document
ISO 8601 timestamp when the content was retrieved
Fetched content URL
Optional<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 BetaCodeExecutionToolResultBlock:
Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
class BetaCodeExecutionToolResultError:
BetaCodeExecutionToolResultErrorCode errorCode
class BetaCodeExecutionResultBlock:
List<BetaCodeExecutionOutputBlock> content
class BetaEncryptedCodeExecutionResultBlock:Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
List<BetaCodeExecutionOutputBlock> content
class BetaBashCodeExecutionToolResultBlock:
Content content
class BetaBashCodeExecutionToolResultError:
ErrorCode errorCode
class BetaBashCodeExecutionResultBlock:
List<BetaBashCodeExecutionOutputBlock> content
class BetaTextEditorCodeExecutionToolResultBlock:
Content content
class BetaTextEditorCodeExecutionToolResultError:
ErrorCode errorCode
class BetaTextEditorCodeExecutionViewResultBlock:
FileType fileType
class BetaTextEditorCodeExecutionCreateResultBlock:
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
class BetaToolSearchToolResultBlock:
Content content
class BetaToolSearchToolResultError:
ErrorCode errorCode
class BetaToolSearchToolSearchResultBlock:
List<BetaToolReferenceBlock> toolReferences
class BetaMcpToolUseBlock:
The name of the MCP tool
The name of the MCP server
class BetaMcpToolResultBlock:
Content content
List<BetaTextBlock>
Optional<List<BetaTextCitation>> citationsCitations supporting the text block.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaContainerUploadBlock:Response model for a file uploaded to the container.
Response model for a file uploaded to the container.
class BetaCompactionBlock:A compaction block returned when autocompact is triggered.
A compaction block returned when autocompact is triggered.
When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops.
Summary of compacted content, or null if compaction failed
Optional<BetaContextManagementResponse> contextManagementContext management response.
Context management response.
Information about context management strategies applied during the request.
List<AppliedEdit> appliedEditsList of context management edits that were applied.
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse:
Number of input tokens cleared by this edit.
Number of tool uses that were cleared.
The type of context management edit applied.
class BetaClearThinking20251015EditResponse:
Number of input tokens cleared by this edit.
Number of thinking turns that were cleared.
The type of context management edit applied.
Model modelThe model that will complete your prompt.
The model that will complete your prompt.
See models for additional details and options.
Most intelligent model for building agents and coding
Frontier intelligence at scale — built for coding, agents, and enterprise workflows
Premium model combining maximum intelligence with practical performance
Premium model combining maximum intelligence with practical performance
High-performance model with early extended thinking
High-performance model with early extended thinking
Fastest and most compact model for near-instant responsiveness
Our fastest model
Hybrid model, capable of near-instant responses and extended thinking
Hybrid model, capable of near-instant responses and extended thinking
High-performance model with extended thinking
High-performance model with extended thinking
High-performance model with extended thinking
Our best model for real-world agents and coding
Our best model for real-world agents and coding
Our most capable model
Our most capable model
Our most capable model
Our most capable model
Excels at writing and complex tasks
Excels at writing and complex tasks
Our previous most fast and cost-effective
JsonValue; role "assistant"constant"assistant"constantConversational role of the generated message.
Conversational role of the generated message.
This will always be "assistant".
Optional<BetaStopReason> stopReasonThe reason that we stopped.
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
Optional<String> stopSequenceWhich custom stop sequence was generated, if any.
Which custom stop sequence was generated, if any.
This value will be a non-null string if one of your custom stop sequences was generated.
JsonValue; type "message"constant"message"constantObject type.
Object type.
For Messages, this is always "message".
BetaUsage usageBilling and rate-limit usage.
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
Optional<BetaCacheCreation> cacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The geographic region where inference was performed for this request.
The number of input tokens which were used.
Optional<List<BetaIterationsUsageItems>> iterationsPer-iteration token usage breakdown.
Per-iteration token usage breakdown.
Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to:
- Determine which iterations exceeded long context thresholds (>=200k tokens)
- Calculate the true context window size from the last iteration
- Understand token accumulation across server-side tool use loops
class BetaMessageIterationUsage:Token usage for a sampling iteration.
Token usage for a sampling iteration.
Optional<BetaCacheCreation> cacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a sampling iteration
class BetaCompactionIterationUsage:Token usage for a compaction iteration.
Token usage for a compaction iteration.
Optional<BetaCacheCreation> cacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a compaction iteration
The number of output tokens which were used.
Optional<BetaServerToolUsage> serverToolUseThe number of server tool requests.
The number of server tool requests.
The number of web fetch tool requests.
The number of web search tool requests.
Optional<ServiceTier> serviceTierIf the request used the priority, standard, or batch tier.
If the request used the priority, standard, or batch tier.
Optional<Speed> speedThe inference speed mode used for this request.
The inference speed mode used for this request.
class BetaRawMessageStreamEvent: A class that can be one of several variants.union
class BetaRawMessageStartEvent:
BetaMessage message
String idUnique object identifier.
Unique object identifier.
The format and length of IDs may change over time.
Optional<BetaContainer> containerInformation about the container used in the request (for the code execution tool)
Information about the container used in the request (for the code execution tool)
Identifier for the container used in this request
The time at which the container will expire.
Optional<List<BetaSkill>> skillsSkills loaded in the container
Skills loaded in the container
Skill ID
Type typeType of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Skill version or 'latest' for most recent version
List<BetaContentBlock> contentContent generated by the model.
Content generated by the model.
This is an array of content blocks, each of which has a type that determines its shape.
Example:
[{"type": "text", "text": "Hi, I'm Claude."}]
If the request input messages ended with an assistant turn, then the response content will continue directly from that last turn. You can use this to constrain the model's output.
For example, if the input messages were:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("}
]
Then the response content might be:
[{"type": "text", "text": "B)"}]
class BetaTextBlock:
Optional<List<BetaTextCitation>> citationsCitations supporting the text block.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaThinkingBlock:
class BetaRedactedThinkingBlock:
class BetaToolUseBlock:
Optional<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 BetaServerToolUseBlock:
Name name
Optional<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 BetaWebSearchToolResultBlock:
class BetaWebSearchToolResultError:
BetaWebSearchToolResultErrorCode errorCode
List<BetaWebSearchResultBlock>
Optional<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 BetaWebFetchToolResultBlock:
Content content
class BetaWebFetchToolResultErrorBlock:
BetaWebFetchToolResultErrorCode errorCode
class BetaWebFetchBlock:
BetaDocumentBlock content
Optional<BetaCitationConfig> citationsCitation configuration for the document
Citation configuration for the document
Source source
class BetaBase64PdfSource:
class BetaPlainTextSource:
The title of the document
ISO 8601 timestamp when the content was retrieved
Fetched content URL
Optional<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 BetaCodeExecutionToolResultBlock:
Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
class BetaCodeExecutionToolResultError:
BetaCodeExecutionToolResultErrorCode errorCode
class BetaCodeExecutionResultBlock:
List<BetaCodeExecutionOutputBlock> content
class BetaEncryptedCodeExecutionResultBlock:Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
List<BetaCodeExecutionOutputBlock> content
class BetaBashCodeExecutionToolResultBlock:
Content content
class BetaBashCodeExecutionToolResultError:
ErrorCode errorCode
class BetaBashCodeExecutionResultBlock:
List<BetaBashCodeExecutionOutputBlock> content
class BetaTextEditorCodeExecutionToolResultBlock:
Content content
class BetaTextEditorCodeExecutionToolResultError:
ErrorCode errorCode
class BetaTextEditorCodeExecutionViewResultBlock:
FileType fileType
class BetaTextEditorCodeExecutionCreateResultBlock:
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
class BetaToolSearchToolResultBlock:
Content content
class BetaToolSearchToolResultError:
ErrorCode errorCode
class BetaToolSearchToolSearchResultBlock:
List<BetaToolReferenceBlock> toolReferences
class BetaMcpToolUseBlock:
The name of the MCP tool
The name of the MCP server
class BetaMcpToolResultBlock:
Content content
List<BetaTextBlock>
Optional<List<BetaTextCitation>> citationsCitations supporting the text block.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaContainerUploadBlock:Response model for a file uploaded to the container.
Response model for a file uploaded to the container.
class BetaCompactionBlock:A compaction block returned when autocompact is triggered.
A compaction block returned when autocompact is triggered.
When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops.
Summary of compacted content, or null if compaction failed
Optional<BetaContextManagementResponse> contextManagementContext management response.
Context management response.
Information about context management strategies applied during the request.
List<AppliedEdit> appliedEditsList of context management edits that were applied.
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse:
Number of input tokens cleared by this edit.
Number of tool uses that were cleared.
The type of context management edit applied.
class BetaClearThinking20251015EditResponse:
Number of input tokens cleared by this edit.
Number of thinking turns that were cleared.
The type of context management edit applied.
Model modelThe model that will complete your prompt.
The model that will complete your prompt.
See models for additional details and options.
Most intelligent model for building agents and coding
Frontier intelligence at scale — built for coding, agents, and enterprise workflows
Premium model combining maximum intelligence with practical performance
Premium model combining maximum intelligence with practical performance
High-performance model with early extended thinking
High-performance model with early extended thinking
Fastest and most compact model for near-instant responsiveness
Our fastest model
Hybrid model, capable of near-instant responses and extended thinking
Hybrid model, capable of near-instant responses and extended thinking
High-performance model with extended thinking
High-performance model with extended thinking
High-performance model with extended thinking
Our best model for real-world agents and coding
Our best model for real-world agents and coding
Our most capable model
Our most capable model
Our most capable model
Our most capable model
Excels at writing and complex tasks
Excels at writing and complex tasks
Our previous most fast and cost-effective
JsonValue; role "assistant"constant"assistant"constantConversational role of the generated message.
Conversational role of the generated message.
This will always be "assistant".
Optional<BetaStopReason> stopReasonThe reason that we stopped.
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
Optional<String> stopSequenceWhich custom stop sequence was generated, if any.
Which custom stop sequence was generated, if any.
This value will be a non-null string if one of your custom stop sequences was generated.
JsonValue; type "message"constant"message"constantObject type.
Object type.
For Messages, this is always "message".
BetaUsage usageBilling and rate-limit usage.
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
Optional<BetaCacheCreation> cacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The geographic region where inference was performed for this request.
The number of input tokens which were used.
Optional<List<BetaIterationsUsageItems>> iterationsPer-iteration token usage breakdown.
Per-iteration token usage breakdown.
Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to:
- Determine which iterations exceeded long context thresholds (>=200k tokens)
- Calculate the true context window size from the last iteration
- Understand token accumulation across server-side tool use loops
class BetaMessageIterationUsage:Token usage for a sampling iteration.
Token usage for a sampling iteration.
Optional<BetaCacheCreation> cacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a sampling iteration
class BetaCompactionIterationUsage:Token usage for a compaction iteration.
Token usage for a compaction iteration.
Optional<BetaCacheCreation> cacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a compaction iteration
The number of output tokens which were used.
Optional<BetaServerToolUsage> serverToolUseThe number of server tool requests.
The number of server tool requests.
The number of web fetch tool requests.
The number of web search tool requests.
Optional<ServiceTier> serviceTierIf the request used the priority, standard, or batch tier.
If the request used the priority, standard, or batch tier.
Optional<Speed> speedThe inference speed mode used for this request.
The inference speed mode used for this request.
class BetaRawMessageDeltaEvent:
Optional<BetaContextManagementResponse> contextManagementInformation about context management strategies applied during the request
Information about context management strategies applied during the request
List<AppliedEdit> appliedEditsList of context management edits that were applied.
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse:
Number of input tokens cleared by this edit.
Number of tool uses that were cleared.
The type of context management edit applied.
class BetaClearThinking20251015EditResponse:
Number of input tokens cleared by this edit.
Number of thinking turns that were cleared.
The type of context management edit applied.
Delta delta
Optional<BetaContainer> containerInformation about the container used in the request (for the code execution tool)
Information about the container used in the request (for the code execution tool)
Identifier for the container used in this request
The time at which the container will expire.
Optional<List<BetaSkill>> skillsSkills loaded in the container
Skills loaded in the container
Skill ID
Type typeType of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Skill version or 'latest' for most recent version
Optional<BetaStopReason> stopReason
BetaMessageDeltaUsage usageBilling and rate-limit usage.
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
The cumulative number of input tokens used to create the cache entry.
The cumulative number of input tokens read from the cache.
The cumulative number of input tokens which were used.
Optional<List<BetaIterationsUsageItems>> iterationsPer-iteration token usage breakdown.
Per-iteration token usage breakdown.
Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to:
- Determine which iterations exceeded long context thresholds (>=200k tokens)
- Calculate the true context window size from the last iteration
- Understand token accumulation across server-side tool use loops
class BetaMessageIterationUsage:Token usage for a sampling iteration.
Token usage for a sampling iteration.
Optional<BetaCacheCreation> cacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a sampling iteration
class BetaCompactionIterationUsage:Token usage for a compaction iteration.
Token usage for a compaction iteration.
Optional<BetaCacheCreation> cacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a compaction iteration
The cumulative number of output tokens which were used.
Optional<BetaServerToolUsage> serverToolUseThe number of server tool requests.
The number of server tool requests.
The number of web fetch tool requests.
The number of web search tool requests.
class BetaRawMessageStopEvent:
class BetaRawContentBlockStartEvent:
ContentBlock contentBlockResponse model for a file uploaded to the container.
Response model for a file uploaded to the container.
class BetaTextBlock:
Optional<List<BetaTextCitation>> citationsCitations supporting the text block.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaThinkingBlock:
class BetaRedactedThinkingBlock:
class BetaToolUseBlock:
Optional<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 BetaServerToolUseBlock:
Name name
Optional<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 BetaWebSearchToolResultBlock:
class BetaWebSearchToolResultError:
BetaWebSearchToolResultErrorCode errorCode
List<BetaWebSearchResultBlock>
Optional<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 BetaWebFetchToolResultBlock:
Content content
class BetaWebFetchToolResultErrorBlock:
BetaWebFetchToolResultErrorCode errorCode
class BetaWebFetchBlock:
BetaDocumentBlock content
Optional<BetaCitationConfig> citationsCitation configuration for the document
Citation configuration for the document
Source source
class BetaBase64PdfSource:
class BetaPlainTextSource:
The title of the document
ISO 8601 timestamp when the content was retrieved
Fetched content URL
Optional<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 BetaCodeExecutionToolResultBlock:
Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
class BetaCodeExecutionToolResultError:
BetaCodeExecutionToolResultErrorCode errorCode
class BetaCodeExecutionResultBlock:
List<BetaCodeExecutionOutputBlock> content
class BetaEncryptedCodeExecutionResultBlock:Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
List<BetaCodeExecutionOutputBlock> content
class BetaBashCodeExecutionToolResultBlock:
Content content
class BetaBashCodeExecutionToolResultError:
ErrorCode errorCode
class BetaBashCodeExecutionResultBlock:
List<BetaBashCodeExecutionOutputBlock> content
class BetaTextEditorCodeExecutionToolResultBlock:
Content content
class BetaTextEditorCodeExecutionToolResultError:
ErrorCode errorCode
class BetaTextEditorCodeExecutionViewResultBlock:
FileType fileType
class BetaTextEditorCodeExecutionCreateResultBlock:
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
class BetaToolSearchToolResultBlock:
Content content
class BetaToolSearchToolResultError:
ErrorCode errorCode
class BetaToolSearchToolSearchResultBlock:
List<BetaToolReferenceBlock> toolReferences
class BetaMcpToolUseBlock:
The name of the MCP tool
The name of the MCP server
class BetaMcpToolResultBlock:
Content content
List<BetaTextBlock>
Optional<List<BetaTextCitation>> citationsCitations supporting the text block.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaContainerUploadBlock:Response model for a file uploaded to the container.
Response model for a file uploaded to the container.
class BetaCompactionBlock:A compaction block returned when autocompact is triggered.
A compaction block returned when autocompact is triggered.
When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops.
Summary of compacted content, or null if compaction failed
class BetaRawContentBlockDeltaEvent:
BetaRawContentBlockDelta delta
class BetaTextDelta:
class BetaInputJsonDelta:
class BetaCitationsDelta:
Citation citation
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaThinkingDelta:
class BetaSignatureDelta:
class BetaCompactionContentBlockDelta:
class BetaRawContentBlockStopEvent:
package com.anthropic.example;
import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import com.anthropic.models.beta.messages.BetaMessage;
import com.anthropic.models.beta.messages.MessageCreateParams;
import com.anthropic.models.messages.Model;
public final class Main {
private Main() {}
public static void main(String[] args) {
AnthropicClient client = AnthropicOkHttpClient.fromEnv();
MessageCreateParams params = MessageCreateParams.builder()
.maxTokens(1024L)
.addUserMessage("Hello, world")
.model(Model.CLAUDE_OPUS_4_6)
.build();
BetaMessage betaMessage = client.beta().messages().create(params);
}
}{
"id": "msg_013Zva2CMHLNnXjNJJKqJ2EF",
"container": {
"id": "id",
"expires_at": "2019-12-27T18:11:19.117Z",
"skills": [
{
"skill_id": "x",
"type": "anthropic",
"version": "x"
}
]
},
"content": [
{
"citations": [
{
"cited_text": "cited_text",
"document_index": 0,
"document_title": "document_title",
"end_char_index": 0,
"file_id": "file_id",
"start_char_index": 0,
"type": "char_location"
}
],
"text": "Hi! My name is Claude.",
"type": "text"
}
],
"context_management": {
"applied_edits": [
{
"cleared_input_tokens": 0,
"cleared_tool_uses": 0,
"type": "clear_tool_uses_20250919"
}
]
},
"model": "claude-opus-4-6",
"role": "assistant",
"stop_reason": "end_turn",
"stop_sequence": null,
"type": "message",
"usage": {
"cache_creation": {
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
},
"cache_creation_input_tokens": 2051,
"cache_read_input_tokens": 2051,
"inference_geo": "inference_geo",
"input_tokens": 2095,
"iterations": [
{
"cache_creation": {
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
},
"cache_creation_input_tokens": 0,
"cache_read_input_tokens": 0,
"input_tokens": 0,
"output_tokens": 0,
"type": "message"
}
],
"output_tokens": 503,
"server_tool_use": {
"web_fetch_requests": 2,
"web_search_requests": 0
},
"service_tier": "standard",
"speed": "standard"
}
}Returns Examples
{
"id": "msg_013Zva2CMHLNnXjNJJKqJ2EF",
"container": {
"id": "id",
"expires_at": "2019-12-27T18:11:19.117Z",
"skills": [
{
"skill_id": "x",
"type": "anthropic",
"version": "x"
}
]
},
"content": [
{
"citations": [
{
"cited_text": "cited_text",
"document_index": 0,
"document_title": "document_title",
"end_char_index": 0,
"file_id": "file_id",
"start_char_index": 0,
"type": "char_location"
}
],
"text": "Hi! My name is Claude.",
"type": "text"
}
],
"context_management": {
"applied_edits": [
{
"cleared_input_tokens": 0,
"cleared_tool_uses": 0,
"type": "clear_tool_uses_20250919"
}
]
},
"model": "claude-opus-4-6",
"role": "assistant",
"stop_reason": "end_turn",
"stop_sequence": null,
"type": "message",
"usage": {
"cache_creation": {
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
},
"cache_creation_input_tokens": 2051,
"cache_read_input_tokens": 2051,
"inference_geo": "inference_geo",
"input_tokens": 2095,
"iterations": [
{
"cache_creation": {
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
},
"cache_creation_input_tokens": 0,
"cache_read_input_tokens": 0,
"input_tokens": 0,
"output_tokens": 0,
"type": "message"
}
],
"output_tokens": 503,
"server_tool_use": {
"web_fetch_requests": 2,
"web_search_requests": 0
},
"service_tier": "standard",
"speed": "standard"
}
}