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
params: MessageCreateParams
betas: Optional<List<AnthropicBeta>>
Optional header to specify the beta version(s) you want to use.
maxTokens: Long
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.
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:
type: JsonValue; "text"constant"text"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
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 BetaCitationCharLocationParam:
type: JsonValue; "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
type: JsonValue; "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
type: JsonValue; "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
type: JsonValue; "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
type: JsonValue; "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
source: Source
class BetaBase64ImageSource:
mediaType: MediaType
type: JsonValue; "base64"constant"base64"constant
class BetaUrlImageSource:
type: JsonValue; "url"constant"url"constant
class BetaFileImageSource:
type: JsonValue; "file"constant"file"constant
type: JsonValue; "image"constant"image"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
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:
mediaType: JsonValue; "application/pdf"constant"application/pdf"constant
type: JsonValue; "base64"constant"base64"constant
class BetaPlainTextSource:
mediaType: JsonValue; "text/plain"constant"text/plain"constant
type: JsonValue; "text"constant"text"constant
class BetaContentBlockSource:
content: Content
class BetaTextBlockParam:
type: JsonValue; "text"constant"text"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
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 BetaCitationCharLocationParam:
type: JsonValue; "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
type: JsonValue; "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
type: JsonValue; "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
type: JsonValue; "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
type: JsonValue; "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
source: Source
class BetaBase64ImageSource:
mediaType: MediaType
type: JsonValue; "base64"constant"base64"constant
class BetaUrlImageSource:
type: JsonValue; "url"constant"url"constant
class BetaFileImageSource:
type: JsonValue; "file"constant"file"constant
type: JsonValue; "image"constant"image"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: JsonValue; "content"constant"content"constant
class BetaUrlPdfSource:
type: JsonValue; "url"constant"url"constant
class BetaFileDocumentSource:
type: JsonValue; "file"constant"file"constant
type: JsonValue; "document"constant"document"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
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:
type: JsonValue; "text"constant"text"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
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 BetaCitationCharLocationParam:
type: JsonValue; "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
type: JsonValue; "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
type: JsonValue; "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
type: JsonValue; "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
type: JsonValue; "search_result_location"constant"search_result_location"constant
type: JsonValue; "search_result"constant"search_result"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
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 BetaThinkingBlockParam:
type: JsonValue; "thinking"constant"thinking"constant
class BetaRedactedThinkingBlockParam:
type: JsonValue; "redacted_thinking"constant"redacted_thinking"constant
class BetaToolUseBlockParam:
type: JsonValue; "tool_use"constant"tool_use"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
caller: Optional<Caller>
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
type: JsonValue; "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
type: JsonValue; "code_execution_20250825"constant"code_execution_20250825"constant
class BetaToolResultBlockParam:
type: JsonValue; "tool_result"constant"tool_result"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
content: Optional<Content>
List<Block>
class BetaTextBlockParam:
type: JsonValue; "text"constant"text"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
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 BetaCitationCharLocationParam:
type: JsonValue; "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
type: JsonValue; "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
type: JsonValue; "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
type: JsonValue; "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
type: JsonValue; "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
source: Source
class BetaBase64ImageSource:
mediaType: MediaType
type: JsonValue; "base64"constant"base64"constant
class BetaUrlImageSource:
type: JsonValue; "url"constant"url"constant
class BetaFileImageSource:
type: JsonValue; "file"constant"file"constant
type: JsonValue; "image"constant"image"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
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:
type: JsonValue; "text"constant"text"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
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 BetaCitationCharLocationParam:
type: JsonValue; "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
type: JsonValue; "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
type: JsonValue; "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
type: JsonValue; "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
type: JsonValue; "search_result_location"constant"search_result_location"constant
type: JsonValue; "search_result"constant"search_result"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
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:
mediaType: JsonValue; "application/pdf"constant"application/pdf"constant
type: JsonValue; "base64"constant"base64"constant
class BetaPlainTextSource:
mediaType: JsonValue; "text/plain"constant"text/plain"constant
type: JsonValue; "text"constant"text"constant
class BetaContentBlockSource:
content: Content
class BetaTextBlockParam:
type: JsonValue; "text"constant"text"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
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 BetaCitationCharLocationParam:
type: JsonValue; "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
type: JsonValue; "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
type: JsonValue; "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
type: JsonValue; "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
type: JsonValue; "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
source: Source
class BetaBase64ImageSource:
mediaType: MediaType
type: JsonValue; "base64"constant"base64"constant
class BetaUrlImageSource:
type: JsonValue; "url"constant"url"constant
class BetaFileImageSource:
type: JsonValue; "file"constant"file"constant
type: JsonValue; "image"constant"image"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: JsonValue; "content"constant"content"constant
class BetaUrlPdfSource:
type: JsonValue; "url"constant"url"constant
class BetaFileDocumentSource:
type: JsonValue; "file"constant"file"constant
type: JsonValue; "document"constant"document"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
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 BetaToolReferenceBlockParam:
Tool reference block that can be included in tool_result content.
type: JsonValue; "tool_reference"constant"tool_reference"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
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
type: JsonValue; "server_tool_use"constant"server_tool_use"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
caller: Optional<Caller>
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
type: JsonValue; "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
type: JsonValue; "code_execution_20250825"constant"code_execution_20250825"constant
class BetaWebSearchToolResultBlockParam:
type: JsonValue; "web_search_result"constant"web_search_result"constant
class BetaWebSearchToolRequestError:
type: JsonValue; "web_search_tool_result_error"constant"web_search_tool_result_error"constant
type: JsonValue; "web_search_tool_result"constant"web_search_tool_result"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
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 BetaWebFetchToolResultBlockParam:
content: Content
class BetaWebFetchToolResultErrorBlockParam:
type: JsonValue; "web_fetch_tool_result_error"constant"web_fetch_tool_result_error"constant
class BetaWebFetchBlockParam:
source: Source
class BetaBase64PdfSource:
mediaType: JsonValue; "application/pdf"constant"application/pdf"constant
type: JsonValue; "base64"constant"base64"constant
class BetaPlainTextSource:
mediaType: JsonValue; "text/plain"constant"text/plain"constant
type: JsonValue; "text"constant"text"constant
class BetaContentBlockSource:
content: Content
class BetaTextBlockParam:
type: JsonValue; "text"constant"text"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
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 BetaCitationCharLocationParam:
type: JsonValue; "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
type: JsonValue; "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
type: JsonValue; "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
type: JsonValue; "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
type: JsonValue; "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
source: Source
class BetaBase64ImageSource:
mediaType: MediaType
type: JsonValue; "base64"constant"base64"constant
class BetaUrlImageSource:
type: JsonValue; "url"constant"url"constant
class BetaFileImageSource:
type: JsonValue; "file"constant"file"constant
type: JsonValue; "image"constant"image"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: JsonValue; "content"constant"content"constant
class BetaUrlPdfSource:
type: JsonValue; "url"constant"url"constant
class BetaFileDocumentSource:
type: JsonValue; "file"constant"file"constant
type: JsonValue; "document"constant"document"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: JsonValue; "web_fetch_result"constant"web_fetch_result"constant
url: String
Fetched content URL
retrievedAt: Optional<String>
ISO 8601 timestamp when the content was retrieved
type: JsonValue; "web_fetch_tool_result"constant"web_fetch_tool_result"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
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 BetaCodeExecutionToolResultBlockParam:
class BetaCodeExecutionToolResultErrorParam:
type: JsonValue; "code_execution_tool_result_error"constant"code_execution_tool_result_error"constant
class BetaCodeExecutionResultBlockParam:
type: JsonValue; "code_execution_output"constant"code_execution_output"constant
type: JsonValue; "code_execution_result"constant"code_execution_result"constant
type: JsonValue; "code_execution_tool_result"constant"code_execution_tool_result"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
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
type: JsonValue; "bash_code_execution_tool_result_error"constant"bash_code_execution_tool_result_error"constant
class BetaBashCodeExecutionResultBlockParam:
type: JsonValue; "bash_code_execution_output"constant"bash_code_execution_output"constant
type: JsonValue; "bash_code_execution_result"constant"bash_code_execution_result"constant
type: JsonValue; "bash_code_execution_tool_result"constant"bash_code_execution_tool_result"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
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
type: JsonValue; "text_editor_code_execution_tool_result_error"constant"text_editor_code_execution_tool_result_error"constant
class BetaTextEditorCodeExecutionViewResultBlockParam:
fileType: FileType
type: JsonValue; "text_editor_code_execution_view_result"constant"text_editor_code_execution_view_result"constant
class BetaTextEditorCodeExecutionCreateResultBlockParam:
type: JsonValue; "text_editor_code_execution_create_result"constant"text_editor_code_execution_create_result"constant
class BetaTextEditorCodeExecutionStrReplaceResultBlockParam:
type: JsonValue; "text_editor_code_execution_str_replace_result"constant"text_editor_code_execution_str_replace_result"constant
type: JsonValue; "text_editor_code_execution_tool_result"constant"text_editor_code_execution_tool_result"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
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
type: JsonValue; "tool_search_tool_result_error"constant"tool_search_tool_result_error"constant
class BetaToolSearchToolSearchResultBlockParam:
type: JsonValue; "tool_reference"constant"tool_reference"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: JsonValue; "tool_search_tool_search_result"constant"tool_search_tool_search_result"constant
type: JsonValue; "tool_search_tool_result"constant"tool_search_tool_result"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
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:
serverName: String
The name of the MCP server
type: JsonValue; "mcp_tool_use"constant"mcp_tool_use"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
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:
type: JsonValue; "mcp_tool_result"constant"mcp_tool_result"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
content: Optional<Content>
List<BetaTextBlockParam>
type: JsonValue; "text"constant"text"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
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 BetaCitationCharLocationParam:
type: JsonValue; "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
type: JsonValue; "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
type: JsonValue; "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
type: JsonValue; "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
type: JsonValue; "search_result_location"constant"search_result_location"constant
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.
type: JsonValue; "container_upload"constant"container_upload"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
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: Model
The model that will complete your prompt.
See models for additional details and options.
container: Optional<Container>
Container identifier for reuse across requests.
class BetaContainerParams:
Container parameters with skills to be loaded.
id: Optional<String>
Container id
List of skills to load in the container
skillId: String
Skill ID
type: Type
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
version: Optional<String>
Skill version or 'latest' for most recent version
Context management configuration.
This allows you to control how Claude manages context across multiple requests, such as whether to clear function results or not.
MCP servers to be utilized in this request
type: JsonValue; "url"constant"url"constant
An object describing metadata about the request.
Configuration options for the model's output. Controls aspects like how much effort the model puts into its response.
A schema to specify Claude's output format in responses.
serviceTier: Optional<ServiceTier>
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.
stopSequences: Optional<List<String>>
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.
system: Optional<System>
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>
type: JsonValue; "text"constant"text"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
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 BetaCitationCharLocationParam:
type: JsonValue; "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
type: JsonValue; "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
type: JsonValue; "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
type: JsonValue; "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
type: JsonValue; "search_result_location"constant"search_result_location"constant
temperature: Optional<Double>
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.
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.
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: InputSchema
JSON schema for this tool's input.
This defines the shape of the input that your tool accepts and that the model will produce.
type: JsonValue; "object"constant"object"constant
name: String
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowedCallers: Optional<List<AllowedCaller>>
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
deferLoading: Optional<Boolean>
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
description: Optional<String>
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.
type: Optional<Type>
class BetaToolBash20241022:
name: JsonValue; "bash"constant"bash"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: JsonValue; "bash_20241022"constant"bash_20241022"constant
allowedCallers: Optional<List<AllowedCaller>>
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
deferLoading: Optional<Boolean>
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolBash20250124:
name: JsonValue; "bash"constant"bash"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: JsonValue; "bash_20250124"constant"bash_20250124"constant
allowedCallers: Optional<List<AllowedCaller>>
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
deferLoading: Optional<Boolean>
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaCodeExecutionTool20250522:
name: JsonValue; "code_execution"constant"code_execution"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: JsonValue; "code_execution_20250522"constant"code_execution_20250522"constant
allowedCallers: Optional<List<AllowedCaller>>
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
deferLoading: Optional<Boolean>
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaCodeExecutionTool20250825:
name: JsonValue; "code_execution"constant"code_execution"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: JsonValue; "code_execution_20250825"constant"code_execution_20250825"constant
allowedCallers: Optional<List<AllowedCaller>>
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
deferLoading: Optional<Boolean>
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolComputerUse20241022:
displayHeightPx: Long
The height of the display in pixels.
displayWidthPx: Long
The width of the display in pixels.
name: JsonValue; "computer"constant"computer"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: JsonValue; "computer_20241022"constant"computer_20241022"constant
allowedCallers: Optional<List<AllowedCaller>>
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
deferLoading: Optional<Boolean>
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
displayNumber: Optional<Long>
The X11 display number (e.g. 0, 1) for the display.
class BetaMemoryTool20250818:
name: JsonValue; "memory"constant"memory"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: JsonValue; "memory_20250818"constant"memory_20250818"constant
allowedCallers: Optional<List<AllowedCaller>>
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
deferLoading: Optional<Boolean>
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolComputerUse20250124:
displayHeightPx: Long
The height of the display in pixels.
displayWidthPx: Long
The width of the display in pixels.
name: JsonValue; "computer"constant"computer"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: JsonValue; "computer_20250124"constant"computer_20250124"constant
allowedCallers: Optional<List<AllowedCaller>>
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
deferLoading: Optional<Boolean>
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
displayNumber: Optional<Long>
The X11 display number (e.g. 0, 1) for the display.
class BetaToolTextEditor20241022:
name: JsonValue; "str_replace_editor"constant"str_replace_editor"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: JsonValue; "text_editor_20241022"constant"text_editor_20241022"constant
allowedCallers: Optional<List<AllowedCaller>>
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
deferLoading: Optional<Boolean>
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolComputerUse20251124:
displayHeightPx: Long
The height of the display in pixels.
displayWidthPx: Long
The width of the display in pixels.
name: JsonValue; "computer"constant"computer"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: JsonValue; "computer_20251124"constant"computer_20251124"constant
allowedCallers: Optional<List<AllowedCaller>>
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
deferLoading: Optional<Boolean>
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
displayNumber: Optional<Long>
The X11 display number (e.g. 0, 1) for the display.
enableZoom: Optional<Boolean>
Whether to enable an action to take a zoomed-in screenshot of the screen.
class BetaToolTextEditor20250124:
name: JsonValue; "str_replace_editor"constant"str_replace_editor"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: JsonValue; "text_editor_20250124"constant"text_editor_20250124"constant
allowedCallers: Optional<List<AllowedCaller>>
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
deferLoading: Optional<Boolean>
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolTextEditor20250429:
name: JsonValue; "str_replace_based_edit_tool"constant"str_replace_based_edit_tool"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: JsonValue; "text_editor_20250429"constant"text_editor_20250429"constant
allowedCallers: Optional<List<AllowedCaller>>
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
deferLoading: Optional<Boolean>
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolTextEditor20250728:
name: JsonValue; "str_replace_based_edit_tool"constant"str_replace_based_edit_tool"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: JsonValue; "text_editor_20250728"constant"text_editor_20250728"constant
allowedCallers: Optional<List<AllowedCaller>>
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
deferLoading: Optional<Boolean>
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
maxCharacters: Optional<Long>
Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.
class BetaWebSearchTool20250305:
name: JsonValue; "web_search"constant"web_search"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: JsonValue; "web_search_20250305"constant"web_search_20250305"constant
allowedCallers: Optional<List<AllowedCaller>>
allowedDomains: Optional<List<String>>
If provided, only these domains will be included in results. Cannot be used alongside blocked_domains.
blockedDomains: Optional<List<String>>
If provided, these domains will never appear in results. Cannot be used alongside allowed_domains.
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
deferLoading: Optional<Boolean>
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
maxUses: Optional<Long>
Maximum number of times the tool can be used in the API request.
userLocation: Optional<UserLocation>
Parameters for the user's location. Used to provide more relevant search results.
type: JsonValue; "approximate"constant"approximate"constant
city: Optional<String>
The city of the user.
country: Optional<String>
The two letter ISO country code of the user.
region: Optional<String>
The region of the user.
timezone: Optional<String>
The IANA timezone of the user.
class BetaWebFetchTool20250910:
name: JsonValue; "web_fetch"constant"web_fetch"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: JsonValue; "web_fetch_20250910"constant"web_fetch_20250910"constant
allowedCallers: Optional<List<AllowedCaller>>
allowedDomains: Optional<List<String>>
List of domains to allow fetching from
blockedDomains: Optional<List<String>>
List of domains to block fetching from
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Citations configuration for fetched documents. Citations are disabled by default.
deferLoading: Optional<Boolean>
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
maxContentTokens: Optional<Long>
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.
maxUses: Optional<Long>
Maximum number of times the tool can be used in the API request.
class BetaToolSearchToolBm25_20251119:
name: JsonValue; "tool_search_tool_bm25"constant"tool_search_tool_bm25"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: Type
allowedCallers: Optional<List<AllowedCaller>>
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
deferLoading: Optional<Boolean>
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolSearchToolRegex20251119:
name: JsonValue; "tool_search_tool_regex"constant"tool_search_tool_regex"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: Type
allowedCallers: Optional<List<AllowedCaller>>
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
deferLoading: Optional<Boolean>
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaMcpToolset:
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.
mcpServerName: String
Name of the MCP server to configure tools for
type: JsonValue; "mcp_toolset"constant"mcp_toolset"constant
Create a cache control breakpoint at this content block.
type: JsonValue; "ephemeral"constant"ephemeral"constant
ttl: Optional<Ttl>
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
configs: Optional<Configs>
Configuration overrides for specific tools, keyed by tool name
Default configuration applied to all tools from this server
topK: Optional<Long>
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.
topP: Optional<Double>
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:
id: String
Unique object identifier.
The format and length of IDs may change over time.
Information about the container used in the request (for the code execution tool)
id: String
Identifier for the container used in this request
expiresAt: LocalDateTime
The time at which the container will expire.
Skills loaded in the container
skillId: String
Skill ID
type: Type
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
version: String
Skill version or 'latest' for most recent version
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:
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:
type: JsonValue; "char_location"constant"char_location"constant
class BetaCitationPageLocation:
type: JsonValue; "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
type: JsonValue; "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
type: JsonValue; "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
type: JsonValue; "search_result_location"constant"search_result_location"constant
type: JsonValue; "text"constant"text"constant
class BetaThinkingBlock:
type: JsonValue; "thinking"constant"thinking"constant
class BetaRedactedThinkingBlock:
type: JsonValue; "redacted_thinking"constant"redacted_thinking"constant
class BetaToolUseBlock:
type: JsonValue; "tool_use"constant"tool_use"constant
caller: Optional<Caller>
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
type: JsonValue; "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
type: JsonValue; "code_execution_20250825"constant"code_execution_20250825"constant
class BetaServerToolUseBlock:
caller: Caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
type: JsonValue; "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
type: JsonValue; "code_execution_20250825"constant"code_execution_20250825"constant
name: Name
type: JsonValue; "server_tool_use"constant"server_tool_use"constant
class BetaWebSearchToolResultBlock:
class BetaWebSearchToolResultError:
type: JsonValue; "web_search_tool_result_error"constant"web_search_tool_result_error"constant
List<BetaWebSearchResultBlock>
type: JsonValue; "web_search_result"constant"web_search_result"constant
type: JsonValue; "web_search_tool_result"constant"web_search_tool_result"constant
class BetaWebFetchToolResultBlock:
content: Content
class BetaWebFetchToolResultErrorBlock:
type: JsonValue; "web_fetch_tool_result_error"constant"web_fetch_tool_result_error"constant
class BetaWebFetchBlock:
Citation configuration for the document
source: Source
class BetaBase64PdfSource:
mediaType: JsonValue; "application/pdf"constant"application/pdf"constant
type: JsonValue; "base64"constant"base64"constant
class BetaPlainTextSource:
mediaType: JsonValue; "text/plain"constant"text/plain"constant
type: JsonValue; "text"constant"text"constant
title: Optional<String>
The title of the document
type: JsonValue; "document"constant"document"constant
retrievedAt: Optional<String>
ISO 8601 timestamp when the content was retrieved
type: JsonValue; "web_fetch_result"constant"web_fetch_result"constant
url: String
Fetched content URL
type: JsonValue; "web_fetch_tool_result"constant"web_fetch_tool_result"constant
class BetaCodeExecutionToolResultBlock:
class BetaCodeExecutionToolResultError:
type: JsonValue; "code_execution_tool_result_error"constant"code_execution_tool_result_error"constant
class BetaCodeExecutionResultBlock:
type: JsonValue; "code_execution_output"constant"code_execution_output"constant
type: JsonValue; "code_execution_result"constant"code_execution_result"constant
type: JsonValue; "code_execution_tool_result"constant"code_execution_tool_result"constant
class BetaBashCodeExecutionToolResultBlock:
content: Content
class BetaBashCodeExecutionToolResultError:
errorCode: ErrorCode
type: JsonValue; "bash_code_execution_tool_result_error"constant"bash_code_execution_tool_result_error"constant
class BetaBashCodeExecutionResultBlock:
type: JsonValue; "bash_code_execution_output"constant"bash_code_execution_output"constant
type: JsonValue; "bash_code_execution_result"constant"bash_code_execution_result"constant
type: JsonValue; "bash_code_execution_tool_result"constant"bash_code_execution_tool_result"constant
class BetaTextEditorCodeExecutionToolResultBlock:
content: Content
class BetaTextEditorCodeExecutionToolResultError:
errorCode: ErrorCode
type: JsonValue; "text_editor_code_execution_tool_result_error"constant"text_editor_code_execution_tool_result_error"constant
class BetaTextEditorCodeExecutionViewResultBlock:
fileType: FileType
type: JsonValue; "text_editor_code_execution_view_result"constant"text_editor_code_execution_view_result"constant
class BetaTextEditorCodeExecutionCreateResultBlock:
type: JsonValue; "text_editor_code_execution_create_result"constant"text_editor_code_execution_create_result"constant
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
type: JsonValue; "text_editor_code_execution_str_replace_result"constant"text_editor_code_execution_str_replace_result"constant
type: JsonValue; "text_editor_code_execution_tool_result"constant"text_editor_code_execution_tool_result"constant
class BetaToolSearchToolResultBlock:
content: Content
class BetaToolSearchToolResultError:
errorCode: ErrorCode
type: JsonValue; "tool_search_tool_result_error"constant"tool_search_tool_result_error"constant
class BetaToolSearchToolSearchResultBlock:
type: JsonValue; "tool_reference"constant"tool_reference"constant
type: JsonValue; "tool_search_tool_search_result"constant"tool_search_tool_search_result"constant
type: JsonValue; "tool_search_tool_result"constant"tool_search_tool_result"constant
class BetaMcpToolUseBlock:
name: String
The name of the MCP tool
serverName: String
The name of the MCP server
type: JsonValue; "mcp_tool_use"constant"mcp_tool_use"constant
class BetaMcpToolResultBlock:
content: Content
List<BetaTextBlock>
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:
type: JsonValue; "char_location"constant"char_location"constant
class BetaCitationPageLocation:
type: JsonValue; "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
type: JsonValue; "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
type: JsonValue; "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
type: JsonValue; "search_result_location"constant"search_result_location"constant
type: JsonValue; "text"constant"text"constant
type: JsonValue; "mcp_tool_result"constant"mcp_tool_result"constant
class BetaContainerUploadBlock:
Response model for a file uploaded to the container.
type: JsonValue; "container_upload"constant"container_upload"constant
Context management response.
Information about context management strategies applied during the request.
appliedEdits: List<AppliedEdit>
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse:
clearedInputTokens: Long
Number of input tokens cleared by this edit.
clearedToolUses: Long
Number of tool uses that were cleared.
type: JsonValue; "clear_tool_uses_20250919"constant"clear_tool_uses_20250919"constant
The type of context management edit applied.
class BetaClearThinking20251015EditResponse:
clearedInputTokens: Long
Number of input tokens cleared by this edit.
clearedThinkingTurns: Long
Number of thinking turns that were cleared.
type: JsonValue; "clear_thinking_20251015"constant"clear_thinking_20251015"constant
The type of context management edit applied.
model: Model
The model that will complete your prompt.
See models for additional details and options.
CLAUDE_OPUS_4_5_20251101("claude-opus-4-5-20251101")
Premium model combining maximum intelligence with practical performance
CLAUDE_OPUS_4_5("claude-opus-4-5")
Premium model combining maximum intelligence with practical performance
CLAUDE_3_7_SONNET_LATEST("claude-3-7-sonnet-latest")
High-performance model with early extended thinking
CLAUDE_3_7_SONNET_20250219("claude-3-7-sonnet-20250219")
High-performance model with early extended thinking
CLAUDE_3_5_HAIKU_LATEST("claude-3-5-haiku-latest")
Fastest and most compact model for near-instant responsiveness
CLAUDE_3_5_HAIKU_20241022("claude-3-5-haiku-20241022")
Our fastest model
CLAUDE_HAIKU_4_5("claude-haiku-4-5")
Hybrid model, capable of near-instant responses and extended thinking
CLAUDE_HAIKU_4_5_20251001("claude-haiku-4-5-20251001")
Hybrid model, capable of near-instant responses and extended thinking
CLAUDE_SONNET_4_20250514("claude-sonnet-4-20250514")
High-performance model with extended thinking
CLAUDE_SONNET_4_0("claude-sonnet-4-0")
High-performance model with extended thinking
CLAUDE_4_SONNET_20250514("claude-4-sonnet-20250514")
High-performance model with extended thinking
CLAUDE_SONNET_4_5("claude-sonnet-4-5")
Our best model for real-world agents and coding
CLAUDE_SONNET_4_5_20250929("claude-sonnet-4-5-20250929")
Our best model for real-world agents and coding
CLAUDE_OPUS_4_0("claude-opus-4-0")
Our most capable model
CLAUDE_OPUS_4_20250514("claude-opus-4-20250514")
Our most capable model
CLAUDE_4_OPUS_20250514("claude-4-opus-20250514")
Our most capable model
CLAUDE_OPUS_4_1_20250805("claude-opus-4-1-20250805")
Our most capable model
CLAUDE_3_OPUS_LATEST("claude-3-opus-latest")
Excels at writing and complex tasks
CLAUDE_3_OPUS_20240229("claude-3-opus-20240229")
Excels at writing and complex tasks
CLAUDE_3_HAIKU_20240307("claude-3-haiku-20240307")
Our previous most fast and cost-effective
role: JsonValue; "assistant"constant"assistant"constant
Conversational role of the generated message.
This will always be "assistant".
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.
stopSequence: Optional<String>
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.
type: JsonValue; "message"constant"message"constant
Object type.
For Messages, this is always "message".
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.
Breakdown of cached tokens by TTL
ephemeral1hInputTokens: Long
The number of input tokens used to create the 1 hour cache entry.
ephemeral5mInputTokens: Long
The number of input tokens used to create the 5 minute cache entry.
cacheCreationInputTokens: Optional<Long>
The number of input tokens used to create the cache entry.
cacheReadInputTokens: Optional<Long>
The number of input tokens read from the cache.
inputTokens: Long
The number of input tokens which were used.
outputTokens: Long
The number of output tokens which were used.
The number of server tool requests.
webFetchRequests: Long
The number of web fetch tool requests.
webSearchRequests: Long
The number of web search tool requests.
serviceTier: Optional<ServiceTier>
If the request used the priority, standard, or batch tier.
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
fun main() {
val client: AnthropicClient = AnthropicOkHttpClient.fromEnv()
val params: MessageCreateParams = MessageCreateParams.builder()
.maxTokens(1024L)
.addUserMessage("Hello, world")
.model(Model.CLAUDE_OPUS_4_5_20251101)
.build()
val 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-sonnet-4-5-20250929",
"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,
"input_tokens": 2095,
"output_tokens": 503,
"server_tool_use": {
"web_fetch_requests": 2,
"web_search_requests": 0
},
"service_tier": "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-sonnet-4-5-20250929",
"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,
"input_tokens": 2095,
"output_tokens": 503,
"server_tool_use": {
"web_fetch_requests": 2,
"web_search_requests": 0
},
"service_tier": "standard"
}
}