Create a Message Batch
Send a batch of Message creation requests.
The Message Batches API can be used to process multiple Messages API requests at once. Once a Message Batch is created, it begins processing immediately. Batches can take up to 24 hours to complete.
Learn more about the Message Batches API in our user guide
ParametersExpand Collapse
requests: Array[{ custom_id, params}]List of requests for prompt completion. Each is an individual request to create a Message.
List of requests for prompt completion. Each is an individual request to create a Message.
Developer-provided ID created for each request in a Message Batch. Useful for matching results to requests, as results may be given out of request order.
Must be unique for each request within the Message Batch.
params: { max_tokens, messages, model, 14 more}Messages API creation parameters for the individual request.
See the Messages API reference for full documentation on available parameters.
Messages API creation parameters for the individual request.
See the Messages API reference for full documentation on available parameters.
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.
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.
Array[BetaContentBlockParam]
class BetaTextBlockParam { text, type, cache_control, citations }
type: :text
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
class BetaBase64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
type: :base64
class BetaURLImageSource { type, url }
type: :url
class BetaFileImageSource { file_id, type }
type: :file
type: :image
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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, type, cache_control, 3 more }
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type } | BetaContentBlockSource { content, type } | 2 more
class BetaBase64PDFSource { data, media_type, type }
media_type: :"application/pdf"
type: :base64
class BetaPlainTextSource { data, media_type, type }
media_type: :"text/plain"
type: :text
class BetaContentBlockSource { content, type }
class BetaTextBlockParam { text, type, cache_control, citations }
type: :text
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
class BetaBase64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
type: :base64
class BetaURLImageSource { type, url }
type: :url
class BetaFileImageSource { file_id, type }
type: :file
type: :image
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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: :content
class BetaURLPDFSource { type, url }
type: :url
class BetaFileDocumentSource { file_id, type }
type: :file
type: :document
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { content, source, title, 3 more }
type: :text
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :search_result
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { signature, thinking, type }
type: :thinking
class BetaRedactedThinkingBlockParam { data, type }
type: :redacted_thinking
class BetaToolUseBlockParam { id, input, name, 2 more }
type: :tool_use
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { tool_use_id, type, cache_control, 2 more }
type: :tool_result
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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: String | Array[BetaTextBlockParam { text, type, cache_control, citations } | BetaImageBlockParam { source, type, cache_control } | BetaSearchResultBlockParam { content, source, title, 3 more } | BetaRequestDocumentBlock { source, type, cache_control, 3 more } ]
Array[BetaTextBlockParam { text, type, cache_control, citations } | BetaImageBlockParam { source, type, cache_control } | BetaSearchResultBlockParam { content, source, title, 3 more } | BetaRequestDocumentBlock { source, type, cache_control, 3 more } ]
class BetaTextBlockParam { text, type, cache_control, citations }
type: :text
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
class BetaBase64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
type: :base64
class BetaURLImageSource { type, url }
type: :url
class BetaFileImageSource { file_id, type }
type: :file
type: :image
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { content, source, title, 3 more }
type: :text
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
type: :search_result
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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, type, cache_control, 3 more }
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type } | BetaContentBlockSource { content, type } | 2 more
class BetaBase64PDFSource { data, media_type, type }
media_type: :"application/pdf"
type: :base64
class BetaPlainTextSource { data, media_type, type }
media_type: :"text/plain"
type: :text
class BetaContentBlockSource { content, type }
class BetaTextBlockParam { text, type, cache_control, citations }
type: :text
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
class BetaBase64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
type: :base64
class BetaURLImageSource { type, url }
type: :url
class BetaFileImageSource { file_id, type }
type: :file
type: :image
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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: :content
class BetaURLPDFSource { type, url }
type: :url
class BetaFileDocumentSource { file_id, type }
type: :file
type: :document
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { id, input, name, 2 more }
name: :web_search | :web_fetch | :code_execution | 2 more
type: :server_tool_use
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { content, tool_use_id, type, cache_control }
Array[BetaWebSearchResultBlockParam { encrypted_content, title, type, 2 more } ]
type: :web_search_result
class BetaWebSearchToolRequestError { error_code, type }
type: :web_search_tool_result_error
type: :web_search_tool_result
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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, tool_use_id, type, cache_control }
content: BetaWebFetchToolResultErrorBlockParam { error_code, type } | BetaWebFetchBlockParam { content, type, url, retrieved_at }
class BetaWebFetchToolResultErrorBlockParam { error_code, type }
type: :web_fetch_tool_result_error
class BetaWebFetchBlockParam { content, type, url, retrieved_at }
source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type } | BetaContentBlockSource { content, type } | 2 more
class BetaBase64PDFSource { data, media_type, type }
media_type: :"application/pdf"
type: :base64
class BetaPlainTextSource { data, media_type, type }
media_type: :"text/plain"
type: :text
class BetaContentBlockSource { content, type }
class BetaTextBlockParam { text, type, cache_control, citations }
type: :text
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaImageBlockParam { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }
class BetaBase64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
type: :base64
class BetaURLImageSource { type, url }
type: :url
class BetaFileImageSource { file_id, type }
type: :file
type: :image
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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: :content
class BetaURLPDFSource { type, url }
type: :url
class BetaFileDocumentSource { file_id, type }
type: :file
type: :document
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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: :web_fetch_result
Fetched content URL
ISO 8601 timestamp when the content was retrieved
type: :web_fetch_tool_result
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { content, tool_use_id, type, cache_control }
class BetaCodeExecutionToolResultErrorParam { error_code, type }
type: :code_execution_tool_result_error
class BetaCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
type: :code_execution_output
type: :code_execution_result
type: :code_execution_tool_result
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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, tool_use_id, type, cache_control }
content: BetaBashCodeExecutionToolResultErrorParam { error_code, type } | BetaBashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
class BetaBashCodeExecutionToolResultErrorParam { error_code, type }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :bash_code_execution_tool_result_error
class BetaBashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
type: :bash_code_execution_output
type: :bash_code_execution_result
type: :bash_code_execution_tool_result
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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, tool_use_id, type, cache_control }
content: BetaTextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message } | BetaTextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more } | BetaTextEditorCodeExecutionCreateResultBlockParam { is_file_update, type } | BetaTextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }
class BetaTextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message }
error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more
type: :text_editor_code_execution_tool_result_error
class BetaTextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more }
file_type: :text | :image | :pdf
type: :text_editor_code_execution_view_result
class BetaTextEditorCodeExecutionCreateResultBlockParam { is_file_update, type }
type: :text_editor_code_execution_create_result
class BetaTextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }
type: :text_editor_code_execution_str_replace_result
type: :text_editor_code_execution_tool_result
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { id, input, name, 3 more }
The name of the MCP server
type: :mcp_tool_use
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { tool_use_id, type, cache_control, 2 more }
type: :mcp_tool_result
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Array[BetaTextBlockParam { text, type, cache_control, citations } ]
type: :text
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
class BetaContainerUploadBlockParam { file_id, type, cache_control } 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.
type: :container_upload
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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: :user | :assistant
:"claude-3-7-sonnet-latest" | :"claude-3-7-sonnet-20250219" | :"claude-3-5-haiku-latest" | 15 moreThe 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
Container identifier for reuse across requests.
Container identifier for reuse across requests.
class BetaContainerParams { id, skills } 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: :anthropic | :customType 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.
Context management configuration.
This allows you to control how Claude manages context across multiple requests, such as whether to clear function results or not.
edits: Array[BetaClearToolUses20250919Edit { type, clear_at_least, clear_tool_inputs, 3 more } | BetaClearThinking20251015Edit { type, keep } ]List of context management edits to apply
List of context management edits to apply
class BetaClearToolUses20250919Edit { type, clear_at_least, clear_tool_inputs, 3 more }
type: :clear_tool_uses_20250919
Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed.
Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed.
type: :input_tokens
clear_tool_inputs: bool | Array[String]Whether to clear all tool inputs (bool) or specific tool inputs to clear (list)
Whether to clear all tool inputs (bool) or specific tool inputs to clear (list)
Tool names whose uses are preserved from clearing
Number of tool uses to retain in the conversation
Number of tool uses to retain in the conversation
type: :tool_uses
Condition that triggers the context management strategy
Condition that triggers the context management strategy
class BetaInputTokensTrigger { type, value }
type: :input_tokens
class BetaToolUsesTrigger { type, value }
type: :tool_uses
class BetaClearThinking20251015Edit { type, keep }
type: :clear_thinking_20251015
Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed.
Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed.
class BetaThinkingTurns { type, value }
type: :thinking_turns
class BetaAllThinkingTurns { type }
type: :all
Keep = :all
MCP servers to be utilized in this request
MCP servers to be utilized in this request
type: :url
An object describing metadata about the request.
An object describing metadata about the request.
An external identifier for the user who is associated with the request.
This should be a uuid, hash value, or other opaque identifier. Anthropic may use this id to help detect abuse. Do not include any identifying information such as name, email address, or phone number.
service_tier: :auto | :standard_onlyDetermines 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.
Whether to incrementally stream the response using server-sent events.
See streaming for details.
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.
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.
Array[BetaTextBlockParam { text, type, cache_control, citations } ]
type: :text
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { cited_text, document_index, document_title, 3 more }
type: :char_location
class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }
type: :page_location
class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
type: :content_block_location
class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
type: :web_search_result_location
class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
type: :search_result_location
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.
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.
class BetaThinkingConfigEnabled { budget_tokens, type }
Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality.
Must be ≥1024 and less than max_tokens.
See extended thinking for details.
type: :enabled
class BetaThinkingConfigDisabled { type }
type: :disabled
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.
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.
class BetaToolChoiceAuto { type, disable_parallel_tool_use } The model will automatically decide whether to use tools.
The model will automatically decide whether to use tools.
type: :auto
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output at most one tool use.
class BetaToolChoiceAny { type, disable_parallel_tool_use } The model will use any available tools.
The model will use any available tools.
type: :any
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
class BetaToolChoiceTool { name, type, disable_parallel_tool_use } The model will use the specified tool with tool_choice.name.
The model will use the specified tool with tool_choice.name.
The name of the tool to use.
type: :tool
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
class BetaToolChoiceNone { type } The model will not be allowed to use tools.
The model will not be allowed to use tools.
type: :none
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 { input_schema, name, cache_control, 2 more }
input_schema: { type, properties, required}JSON 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.
type: :object
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.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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.
type: :custom
class BetaToolBash20241022 { name, type, cache_control }
name: :bashName 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.
type: :bash_20241022
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { name, type, cache_control }
name: :bashName 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.
type: :bash_20250124
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { name, type, cache_control }
name: :code_executionName 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.
type: :code_execution_20250522
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { name, type, cache_control }
name: :code_executionName 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.
type: :code_execution_20250825
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { display_height_px, display_width_px, name, 3 more }
The height of the display in pixels.
The width of the display in pixels.
name: :computerName 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.
type: :computer_20241022
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { name, type, cache_control }
name: :memoryName 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.
type: :memory_20250818
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { display_height_px, display_width_px, name, 3 more }
The height of the display in pixels.
The width of the display in pixels.
name: :computerName 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.
type: :computer_20250124
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { name, type, cache_control }
name: :str_replace_editorName 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.
type: :text_editor_20241022
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { name, type, cache_control }
name: :str_replace_editorName 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.
type: :text_editor_20250124
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { name, type, cache_control }
name: :str_replace_based_edit_toolName 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.
type: :text_editor_20250429
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { name, type, cache_control, max_characters }
name: :str_replace_based_edit_toolName 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.
type: :text_editor_20250728
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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 { name, type, allowed_domains, 4 more }
name: :web_searchName 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.
type: :web_search_20250305
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.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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.
user_location: { type, city, country, 2 more}Parameters 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.
type: :approximate
The city of the user.
The region of the user.
class BetaWebFetchTool20250910 { name, type, allowed_domains, 5 more }
name: :web_fetchName 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.
type: :web_fetch_20250910
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.
type: :ephemeral
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes
1h: 1 hour
Defaults to 5m.
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.
Optional header to specify the beta version(s) you want to use.
Optional header to specify the beta version(s) you want to use.
:"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 15 more
ReturnsExpand Collapse
class BetaMessageBatch { id, archived_at, cancel_initiated_at, 7 more }
Unique object identifier.
The format and length of IDs may change over time.
RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.
RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated.
RFC 3339 datetime string representing the time at which the Message Batch was created.
RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends.
Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired.
RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation.
processing_status: :in_progress | :canceling | :endedProcessing status of the Message Batch.
Processing status of the Message Batch.
Tallies requests within the Message Batch, categorized by their status.
Requests start as processing and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch.
Tallies requests within the Message Batch, categorized by their status.
Requests start as processing and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch.
Number of requests in the Message Batch that have been canceled.
This is zero until processing of the entire Message Batch has ended.
Number of requests in the Message Batch that encountered an error.
This is zero until processing of the entire Message Batch has ended.
Number of requests in the Message Batch that have expired.
This is zero until processing of the entire Message Batch has ended.
Number of requests in the Message Batch that are processing.
Number of requests in the Message Batch that have completed successfully.
This is zero until processing of the entire Message Batch has ended.
URL to a .jsonl file containing the results of the Message Batch requests. Specified only once processing ends.
Results in the file are not guaranteed to be in the same order as requests. Use the custom_id field to match results to requests.
type: :message_batchObject type.
For Message Batches, this is always "message_batch".
Object type.
For Message Batches, this is always "message_batch".
Create a Message Batch
require "anthropic"
anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key")
beta_message_batch = anthropic.beta.messages.batches.create(
requests: [
{
custom_id: "my-custom-id-1",
params: {max_tokens: 1024, messages: [{content: "Hello, world", role: :user}], model: :"claude-3-7-sonnet-latest"}
}
]
)
puts(beta_message_batch){
"id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
"archived_at": "2024-08-20T18:37:24.100435Z",
"cancel_initiated_at": "2024-08-20T18:37:24.100435Z",
"created_at": "2024-08-20T18:37:24.100435Z",
"ended_at": "2024-08-20T18:37:24.100435Z",
"expires_at": "2024-08-20T18:37:24.100435Z",
"processing_status": "in_progress",
"request_counts": {
"canceled": 10,
"errored": 30,
"expired": 10,
"processing": 100,
"succeeded": 50
},
"results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results",
"type": "message_batch"
}Returns Examples
{
"id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
"archived_at": "2024-08-20T18:37:24.100435Z",
"cancel_initiated_at": "2024-08-20T18:37:24.100435Z",
"created_at": "2024-08-20T18:37:24.100435Z",
"ended_at": "2024-08-20T18:37:24.100435Z",
"expires_at": "2024-08-20T18:37:24.100435Z",
"processing_status": "in_progress",
"request_counts": {
"canceled": 10,
"errored": 30,
"expired": 10,
"processing": 100,
"succeeded": 50
},
"results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results",
"type": "message_batch"
}