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.
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.
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.
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:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
class BetaContentBlockSource:
Content content
class BetaTextBlockParam:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "content"constant"content"constant
class BetaUrlPdfSource:
JsonValue; type "url"constant"url"constant
class BetaFileDocumentSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "document"constant"document"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "search_result"constant"search_result"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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:
JsonValue; type "thinking"constant"thinking"constant
class BetaRedactedThinkingBlockParam:
JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
class BetaToolUseBlockParam:
JsonValue; type "tool_use"constant"tool_use"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 BetaToolResultBlockParam:
JsonValue; type "tool_result"constant"tool_result"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "search_result"constant"search_result"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
class BetaContentBlockSource:
Content content
class BetaTextBlockParam:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "content"constant"content"constant
class BetaUrlPdfSource:
JsonValue; type "url"constant"url"constant
class BetaFileDocumentSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "document"constant"document"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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
JsonValue; type "server_tool_use"constant"server_tool_use"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 BetaWebSearchToolResultBlockParam:
JsonValue; type "web_search_result"constant"web_search_result"constant
class BetaWebSearchToolRequestError:
BetaWebSearchToolResultErrorCode errorCode
JsonValue; type "web_search_tool_result_error"constant"web_search_tool_result_error"constant
JsonValue; type "web_search_tool_result"constant"web_search_tool_result"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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:
BetaWebFetchToolResultErrorCode errorCode
JsonValue; type "web_fetch_tool_result_error"constant"web_fetch_tool_result_error"constant
class BetaWebFetchBlockParam:
BetaRequestDocumentBlock content
Source source
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
class BetaContentBlockSource:
Content content
class BetaTextBlockParam:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "content"constant"content"constant
class BetaUrlPdfSource:
JsonValue; type "url"constant"url"constant
class BetaFileDocumentSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "document"constant"document"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "web_fetch_result"constant"web_fetch_result"constant
Fetched content URL
ISO 8601 timestamp when the content was retrieved
JsonValue; type "web_fetch_tool_result"constant"web_fetch_tool_result"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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:
BetaCodeExecutionToolResultErrorCode errorCode
JsonValue; type "code_execution_tool_result_error"constant"code_execution_tool_result_error"constant
class BetaCodeExecutionResultBlockParam:
List<BetaCodeExecutionOutputBlockParam> content
JsonValue; type "code_execution_output"constant"code_execution_output"constant
JsonValue; type "code_execution_result"constant"code_execution_result"constant
JsonValue; type "code_execution_tool_result"constant"code_execution_tool_result"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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
JsonValue; type "bash_code_execution_tool_result_error"constant"bash_code_execution_tool_result_error"constant
class BetaBashCodeExecutionResultBlockParam:
List<BetaBashCodeExecutionOutputBlockParam> content
JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
JsonValue; type "bash_code_execution_tool_result"constant"bash_code_execution_tool_result"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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
JsonValue; type "text_editor_code_execution_tool_result_error"constant"text_editor_code_execution_tool_result_error"constant
class BetaTextEditorCodeExecutionViewResultBlockParam:
FileType fileType
JsonValue; type "text_editor_code_execution_view_result"constant"text_editor_code_execution_view_result"constant
class BetaTextEditorCodeExecutionCreateResultBlockParam:
JsonValue; type "text_editor_code_execution_create_result"constant"text_editor_code_execution_create_result"constant
class BetaTextEditorCodeExecutionStrReplaceResultBlockParam:
JsonValue; type "text_editor_code_execution_str_replace_result"constant"text_editor_code_execution_str_replace_result"constant
JsonValue; type "text_editor_code_execution_tool_result"constant"text_editor_code_execution_tool_result"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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
JsonValue; type "mcp_tool_use"constant"mcp_tool_use"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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:
JsonValue; type "mcp_tool_result"constant"mcp_tool_result"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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>
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "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.
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.
JsonValue; type "container_upload"constant"container_upload"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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
The model that will complete your prompt.
See models for additional details and options.
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
List 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
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
MCP servers to be utilized in this request
JsonValue; type "url"constant"url"constant
An object describing metadata about the request.
Optional<ServiceTier> serviceTierDetermines 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.
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.
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.
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.
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>
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
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 tool input shape that the model will produce in tool_use output content blocks.
For example, if you defined tools as:
[
{
"name": "get_stock_price",
"description": "Get the current stock price for a given ticker symbol.",
"input_schema": {
"type": "object",
"properties": {
"ticker": {
"type": "string",
"description": "The stock ticker symbol, e.g. AAPL for Apple Inc."
}
},
"required": ["ticker"]
}
}
]
And then asked the model "What's the S&P 500 at today?", the model might produce tool_use content blocks in the response like this:
[
{
"type": "tool_use",
"id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
"name": "get_stock_price",
"input": { "ticker": "^GSPC" }
}
]
You might then run your get_stock_price tool with {"ticker": "^GSPC"} as an input, and return the following back to the model in a subsequent user message:
[
{
"type": "tool_result",
"tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
"content": "259.75 USD"
}
]
Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output.
See our guide for more details.
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.
This defines the shape of the input that your tool accepts and that the model will produce.
JSON schema for this tool's input.
This defines the shape of the input that your tool accepts and that the model will produce.
JsonValue; type "object"constant"object"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
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.
Optional<Type> type
class BetaToolBash20241022:
JsonValue; name "bash"constant"bash"constantName of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "bash_20241022"constant"bash_20241022"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 BetaToolBash20250124:
JsonValue; name "bash"constant"bash"constantName of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "bash_20250124"constant"bash_20250124"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 BetaCodeExecutionTool20250522:
JsonValue; name "code_execution"constant"code_execution"constantName of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "code_execution_20250522"constant"code_execution_20250522"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 BetaCodeExecutionTool20250825:
JsonValue; name "code_execution"constant"code_execution"constantName of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 BetaToolComputerUse20241022:
The height of the display in pixels.
The width of the display in pixels.
JsonValue; name "computer"constant"computer"constantName of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "computer_20241022"constant"computer_20241022"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
The X11 display number (e.g. 0, 1) for the display.
class BetaMemoryTool20250818:
JsonValue; name "memory"constant"memory"constantName of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "memory_20250818"constant"memory_20250818"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 BetaToolComputerUse20250124:
The height of the display in pixels.
The width of the display in pixels.
JsonValue; name "computer"constant"computer"constantName of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "computer_20250124"constant"computer_20250124"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
The X11 display number (e.g. 0, 1) for the display.
class BetaToolTextEditor20241022:
JsonValue; name "str_replace_editor"constant"str_replace_editor"constantName of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "text_editor_20241022"constant"text_editor_20241022"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 BetaToolTextEditor20250124:
JsonValue; name "str_replace_editor"constant"str_replace_editor"constantName of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "text_editor_20250124"constant"text_editor_20250124"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 BetaToolTextEditor20250429:
JsonValue; name "str_replace_based_edit_tool"constant"str_replace_based_edit_tool"constantName of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "text_editor_20250429"constant"text_editor_20250429"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 BetaToolTextEditor20250728:
JsonValue; name "str_replace_based_edit_tool"constant"str_replace_based_edit_tool"constantName of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "text_editor_20250728"constant"text_editor_20250728"constant
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.
class BetaWebSearchTool20250305:
JsonValue; name "web_search"constant"web_search"constantName of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "web_search_20250305"constant"web_search_20250305"constant
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.
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Maximum number of times the tool can be used in the API request.
Optional<UserLocation> 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.
JsonValue; type "approximate"constant"approximate"constant
The city of the user.
The region of the user.
class BetaWebFetchTool20250910:
JsonValue; name "web_fetch"constant"web_fetch"constantName of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "web_fetch_20250910"constant"web_fetch_20250910"constant
List of domains to allow fetching from
List of domains to block fetching from
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttlThe time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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.
Citations configuration for fetched documents. Citations are disabled by default.
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.
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.
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:
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)
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.
Skills 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.
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)"}]
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.
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:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "text"constant"text"constant
class BetaThinkingBlock:
JsonValue; type "thinking"constant"thinking"constant
class BetaRedactedThinkingBlock:
JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
class BetaToolUseBlock:
JsonValue; type "tool_use"constant"tool_use"constant
class BetaServerToolUseBlock:
Name name
JsonValue; type "server_tool_use"constant"server_tool_use"constant
class BetaWebSearchToolResultBlock:
class BetaWebSearchToolResultError:
BetaWebSearchToolResultErrorCode errorCode
JsonValue; type "web_search_tool_result_error"constant"web_search_tool_result_error"constant
List<BetaWebSearchResultBlock>
JsonValue; type "web_search_result"constant"web_search_result"constant
JsonValue; type "web_search_tool_result"constant"web_search_tool_result"constant
class BetaWebFetchToolResultBlock:
Content content
class BetaWebFetchToolResultErrorBlock:
BetaWebFetchToolResultErrorCode errorCode
JsonValue; type "web_fetch_tool_result_error"constant"web_fetch_tool_result_error"constant
class BetaWebFetchBlock:
BetaDocumentBlock content
Citation configuration for the document
Citation configuration for the document
Source source
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
The title of the document
JsonValue; type "document"constant"document"constant
ISO 8601 timestamp when the content was retrieved
JsonValue; type "web_fetch_result"constant"web_fetch_result"constant
Fetched content URL
JsonValue; type "web_fetch_tool_result"constant"web_fetch_tool_result"constant
class BetaCodeExecutionToolResultBlock:
class BetaCodeExecutionToolResultError:
BetaCodeExecutionToolResultErrorCode errorCode
JsonValue; type "code_execution_tool_result_error"constant"code_execution_tool_result_error"constant
class BetaCodeExecutionResultBlock:
List<BetaCodeExecutionOutputBlock> content
JsonValue; type "code_execution_output"constant"code_execution_output"constant
JsonValue; type "code_execution_result"constant"code_execution_result"constant
JsonValue; type "code_execution_tool_result"constant"code_execution_tool_result"constant
class BetaBashCodeExecutionToolResultBlock:
Content content
class BetaBashCodeExecutionToolResultError:
ErrorCode errorCode
JsonValue; type "bash_code_execution_tool_result_error"constant"bash_code_execution_tool_result_error"constant
class BetaBashCodeExecutionResultBlock:
List<BetaBashCodeExecutionOutputBlock> content
JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
JsonValue; type "bash_code_execution_tool_result"constant"bash_code_execution_tool_result"constant
class BetaTextEditorCodeExecutionToolResultBlock:
Content content
class BetaTextEditorCodeExecutionToolResultError:
ErrorCode errorCode
JsonValue; type "text_editor_code_execution_tool_result_error"constant"text_editor_code_execution_tool_result_error"constant
class BetaTextEditorCodeExecutionViewResultBlock:
FileType fileType
JsonValue; type "text_editor_code_execution_view_result"constant"text_editor_code_execution_view_result"constant
class BetaTextEditorCodeExecutionCreateResultBlock:
JsonValue; type "text_editor_code_execution_create_result"constant"text_editor_code_execution_create_result"constant
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
JsonValue; type "text_editor_code_execution_str_replace_result"constant"text_editor_code_execution_str_replace_result"constant
JsonValue; type "text_editor_code_execution_tool_result"constant"text_editor_code_execution_tool_result"constant
class BetaMcpToolUseBlock:
The name of the MCP tool
The name of the MCP server
JsonValue; type "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.
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:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "text"constant"text"constant
JsonValue; type "mcp_tool_result"constant"mcp_tool_result"constant
class BetaContainerUploadBlock:Response model for a file uploaded to the container.
Response model for a file uploaded to the container.
JsonValue; type "container_upload"constant"container_upload"constant
Context management response.
Information about context management strategies applied during the request.
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.
JsonValue; type "clear_tool_uses_20250919"constant"clear_tool_uses_20250919"constantThe type of context management edit applied.
The type of context management edit applied.
class BetaClearThinking20251015EditResponse:
Number of input tokens cleared by this edit.
Number of thinking turns that were cleared.
JsonValue; type "clear_thinking_20251015"constant"clear_thinking_20251015"constantThe type of context management edit applied.
The type of context management edit applied.
Model modelThe model that will complete your prompt.
See models for additional details and options.
The model that will complete your prompt.
See models for additional details and options.
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.
This will always be "assistant".
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 requested max_tokens or the model's maximum
"stop_sequence": one of your provided custom stop_sequences was 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.
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.
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.
For Messages, this is always "message".
Object type.
For Messages, this is always "message".
BetaUsage usageBilling 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.
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
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.
The 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.
Create a Message
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_3_7_SONNET_LATEST)
.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-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"
}
}