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
BatchCreateParams parameters
required IReadOnlyList<Request> requestsBody param: List of requests for prompt completion. Each is an individual request to create a Message.
Body param: List of requests for prompt completion. Each is an individual request to create a Message.
required string CustomIDDeveloper-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.
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.
required Params ParamsMessages API creation parameters for the individual request.
Messages API creation parameters for the individual request.
See the Messages API reference for full documentation on available parameters.
required Long MaxTokensThe maximum number of tokens to generate before stopping.
The maximum number of tokens to generate before stopping.
Note that our models may stop before reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate.
Different models have different maximum values for this parameter. See models for details.
required IReadOnlyList<BetaMessageParam> MessagesInput messages.
Input messages.
Our models are trained to operate on alternating user and assistant conversational turns. When creating a new Message, you specify the prior conversational turns with the messages parameter, and the model then generates the next Message in the conversation. Consecutive user or assistant turns in your request will be combined into a single turn.
Each input message must be an object with a role and content. You can specify a single user-role message, or you can include multiple user and assistant messages.
If the final message uses the assistant role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response.
Example with a single user message:
[{"role": "user", "content": "Hello, Claude"}]
Example with multiple conversational turns:
[
{"role": "user", "content": "Hello there."},
{"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"},
{"role": "user", "content": "Can you explain LLMs in plain English?"},
]
Example with a partially-filled response from Claude:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("},
]
Each input message content may be either a single string or an array of content blocks, where each block has a specific type. Using a string for content is shorthand for an array of one content block of type "text". The following input messages are equivalent:
{"role": "user", "content": "Hello, Claude"}
{"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]}
See input examples.
Note that if you want to include a system prompt, you can use the top-level system parameter — there is no "system" role for input messages in the Messages API.
There is a limit of 100,000 messages in a single request.
required Content Content
IReadOnlyList<BetaContentBlockParam>
class BetaTextBlockParam:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
IReadOnlyList<BetaTextCitationParam>? Citations
class BetaCitationCharLocationParam:
class BetaCitationPageLocationParam:
class BetaCitationContentBlockLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationSearchResultLocationParam:
class BetaImageBlockParam:
required Source Source
class BetaBase64ImageSource:
required MediaType MediaType
class BetaUrlImageSource:
class BetaFileImageSource:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaRequestDocumentBlock:
required Source Source
class BetaBase64PdfSource:
class BetaPlainTextSource:
class BetaContentBlockSource:
required Content Content
IReadOnlyList<BetaContentBlockSourceContent>
class BetaTextBlockParam:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
IReadOnlyList<BetaTextCitationParam>? Citations
class BetaCitationCharLocationParam:
class BetaCitationPageLocationParam:
class BetaCitationContentBlockLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationSearchResultLocationParam:
class BetaImageBlockParam:
required Source Source
class BetaBase64ImageSource:
required MediaType MediaType
class BetaUrlImageSource:
class BetaFileImageSource:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaUrlPdfSource:
class BetaFileDocumentSource:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaCitationsConfigParam? Citations
class BetaSearchResultBlockParam:
required IReadOnlyList<BetaTextBlockParam> Content
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
IReadOnlyList<BetaTextCitationParam>? Citations
class BetaCitationCharLocationParam:
class BetaCitationPageLocationParam:
class BetaCitationContentBlockLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationSearchResultLocationParam:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaCitationsConfigParam Citations
class BetaThinkingBlockParam:
class BetaRedactedThinkingBlockParam:
class BetaToolUseBlockParam:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaToolResultBlockParam:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Content Content
IReadOnlyList<Block>
class BetaTextBlockParam:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
IReadOnlyList<BetaTextCitationParam>? Citations
class BetaCitationCharLocationParam:
class BetaCitationPageLocationParam:
class BetaCitationContentBlockLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationSearchResultLocationParam:
class BetaImageBlockParam:
required Source Source
class BetaBase64ImageSource:
required MediaType MediaType
class BetaUrlImageSource:
class BetaFileImageSource:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaSearchResultBlockParam:
required IReadOnlyList<BetaTextBlockParam> Content
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
IReadOnlyList<BetaTextCitationParam>? Citations
class BetaCitationCharLocationParam:
class BetaCitationPageLocationParam:
class BetaCitationContentBlockLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationSearchResultLocationParam:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaCitationsConfigParam Citations
class BetaRequestDocumentBlock:
required Source Source
class BetaBase64PdfSource:
class BetaPlainTextSource:
class BetaContentBlockSource:
required Content Content
IReadOnlyList<BetaContentBlockSourceContent>
class BetaTextBlockParam:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
IReadOnlyList<BetaTextCitationParam>? Citations
class BetaCitationCharLocationParam:
class BetaCitationPageLocationParam:
class BetaCitationContentBlockLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationSearchResultLocationParam:
class BetaImageBlockParam:
required Source Source
class BetaBase64ImageSource:
required MediaType MediaType
class BetaUrlImageSource:
class BetaFileImageSource:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaUrlPdfSource:
class BetaFileDocumentSource:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaCitationsConfigParam? Citations
class BetaToolReferenceBlockParam:Tool reference block that can be included in tool_result content.
Tool reference block that can be included in tool_result content.
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaServerToolUseBlockParam:
required Name Name
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaWebSearchToolResultBlockParam:
required BetaWebSearchToolResultBlockParamContent Content
IReadOnlyList<BetaWebSearchResultBlockParam>
class BetaWebSearchToolRequestError:
required BetaWebSearchToolResultErrorCode ErrorCode
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaWebFetchToolResultBlockParam:
required Content Content
class BetaWebFetchToolResultErrorBlockParam:
required BetaWebFetchToolResultErrorCode ErrorCode
class BetaWebFetchBlockParam:
required BetaRequestDocumentBlock Content
required Source Source
class BetaBase64PdfSource:
class BetaPlainTextSource:
class BetaContentBlockSource:
required Content Content
IReadOnlyList<BetaContentBlockSourceContent>
class BetaTextBlockParam:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
IReadOnlyList<BetaTextCitationParam>? Citations
class BetaCitationCharLocationParam:
class BetaCitationPageLocationParam:
class BetaCitationContentBlockLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationSearchResultLocationParam:
class BetaImageBlockParam:
required Source Source
class BetaBase64ImageSource:
required MediaType MediaType
class BetaUrlImageSource:
class BetaFileImageSource:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaUrlPdfSource:
class BetaFileDocumentSource:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaCitationsConfigParam? Citations
Fetched content URL
ISO 8601 timestamp when the content was retrieved
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaCodeExecutionToolResultBlockParam:
required BetaCodeExecutionToolResultBlockParamContent ContentCode execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
class BetaCodeExecutionToolResultErrorParam:
required BetaCodeExecutionToolResultErrorCode ErrorCode
class BetaCodeExecutionResultBlockParam:
required IReadOnlyList<BetaCodeExecutionOutputBlockParam> Content
class BetaEncryptedCodeExecutionResultBlockParam:Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
required IReadOnlyList<BetaCodeExecutionOutputBlockParam> Content
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaBashCodeExecutionToolResultBlockParam:
required Content Content
class BetaBashCodeExecutionToolResultErrorParam:
required ErrorCode ErrorCode
class BetaBashCodeExecutionResultBlockParam:
required IReadOnlyList<BetaBashCodeExecutionOutputBlockParam> Content
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaTextEditorCodeExecutionToolResultBlockParam:
required Content Content
class BetaTextEditorCodeExecutionToolResultErrorParam:
required ErrorCode ErrorCode
class BetaTextEditorCodeExecutionViewResultBlockParam:
required FileType FileType
class BetaTextEditorCodeExecutionCreateResultBlockParam:
class BetaTextEditorCodeExecutionStrReplaceResultBlockParam:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaToolSearchToolResultBlockParam:
required Content Content
class BetaToolSearchToolResultErrorParam:
required ErrorCode ErrorCode
class BetaToolSearchToolSearchResultBlockParam:
required IReadOnlyList<BetaToolReferenceBlockParam> ToolReferences
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaMcpToolUseBlockParam:
The name of the MCP server
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaRequestMcpToolResultBlockParam:
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Content Content
IReadOnlyList<BetaTextBlockParam>
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
IReadOnlyList<BetaTextCitationParam>? Citations
class BetaCitationCharLocationParam:
class BetaCitationPageLocationParam:
class BetaCitationContentBlockLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationSearchResultLocationParam:
class BetaContainerUploadBlockParam:A content block that represents a file to be uploaded to the container
Files uploaded via this block will be available in the container's input directory.
A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory.
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCompactionBlockParam:A compaction block containing summary of previous context.
A compaction block containing summary of previous context.
Users should round-trip these blocks from responses to subsequent requests to maintain context across compaction boundaries.
When content is None, the block represents a failed compaction. The server treats these as no-ops. Empty string content is not allowed.
Summary of previously compacted content, or null if compaction failed
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
required Role Role
required Model ModelThe model that will complete your prompt.
The model that will complete your prompt.
See models for additional details and options.
Most intelligent model for building agents and coding
Frontier intelligence at scale — built for coding, agents, and enterprise workflows
Premium model combining maximum intelligence with practical performance
Premium model combining maximum intelligence with practical performance
High-performance model with early extended thinking
High-performance model with early extended thinking
Fastest and most compact model for near-instant responsiveness
Our fastest model
Hybrid model, capable of near-instant responses and extended thinking
Hybrid model, capable of near-instant responses and extended thinking
High-performance model with extended thinking
High-performance model with extended thinking
High-performance model with extended thinking
Our best model for real-world agents and coding
Our best model for real-world agents and coding
Our most capable model
Our most capable model
Our most capable model
Our most capable model
Excels at writing and complex tasks
Excels at writing and complex tasks
Our previous most fast and cost-effective
BetaCacheControlEphemeral? CacheControlTop-level cache control automatically applies a cache_control marker to the last cacheable block in the request.
Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
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
IReadOnlyList<BetaSkillParams>? SkillsList of skills to load in the container
List of skills to load in the container
Skill ID
required 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
BetaContextManagementConfig? ContextManagementContext management configuration.
Context management configuration.
This allows you to control how Claude manages context across multiple requests, such as whether to clear function results or not.
IReadOnlyList<Edit> EditsList of context management edits to apply
List of context management edits to apply
class BetaClearToolUses20250919Edit:
BetaInputTokensClearAtLeast? ClearAtLeastMinimum 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.
ClearToolInputs? ClearToolInputsWhether 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
BetaToolUsesKeep KeepNumber of tool uses to retain in the conversation
Number of tool uses to retain in the conversation
Trigger TriggerCondition that triggers the context management strategy
Condition that triggers the context management strategy
class BetaInputTokensTrigger:
class BetaToolUsesTrigger:
class BetaClearThinking20251015Edit:
Keep KeepNumber 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:
class BetaAllThinkingTurns:
class BetaCompact20260112Edit:Automatically compact older context when reaching the configured trigger threshold.
Automatically compact older context when reaching the configured trigger threshold.
Additional instructions for summarization.
Whether to pause after compaction and return the compaction block to the user.
BetaInputTokensTrigger? TriggerWhen to trigger compaction. Defaults to 150000 input tokens.
When to trigger compaction. Defaults to 150000 input tokens.
Specifies the geographic region for inference processing. If not specified, the workspace's default_inference_geo is used.
IReadOnlyList<BetaRequestMcpServerUrlDefinition> McpServersMCP servers to be utilized in this request
MCP servers to be utilized in this request
BetaRequestMcpServerToolConfiguration? ToolConfiguration
BetaMetadata MetadataAn object describing metadata about the request.
An object describing metadata about the request.
string? UserIDAn external identifier for the user who is associated with 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.
BetaOutputConfig OutputConfigConfiguration options for the model's output, such as the output format.
Configuration options for the model's output, such as the output format.
Effort? EffortAll possible effort levels.
All possible effort levels.
BetaJsonOutputFormat? FormatA schema to specify Claude's output format in responses. See structured outputs
A schema to specify Claude's output format in responses. See structured outputs
The JSON schema of the format
DeprecatedBetaJsonOutputFormat? OutputFormatDeprecated: Use output_config.format instead. See structured outputs
Deprecated: Use output_config.format instead. See structured outputs
A schema to specify Claude's output format in responses. This parameter will be removed in a future release.
The JSON schema of the format
ServiceTier ServiceTierDetermines whether to use priority capacity (if available) or standard capacity for this request.
Determines whether to use priority capacity (if available) or standard capacity for this request.
Anthropic offers different levels of service for your API requests. See service-tiers for details.
Speed? SpeedThe inference speed mode for this request. "fast" enables high output-tokens-per-second inference.
The inference speed mode for this request. "fast" enables high output-tokens-per-second inference.
IReadOnlyList<string> StopSequencesCustom text sequences that will cause the model to stop generating.
Custom text sequences that will cause the model to stop generating.
Our models will normally stop when they have naturally completed their turn, which will result in a response stop_reason of "end_turn".
If you want the model to stop generating when it encounters custom strings of text, you can use the stop_sequences parameter. If the model encounters one of the custom sequences, the response stop_reason value will be "stop_sequence" and the response stop_sequence value will contain the matched stop sequence.
Boolean StreamWhether to incrementally stream the response using server-sent events.
Whether to incrementally stream the response using server-sent events.
See streaming for details.
System SystemSystem prompt.
System prompt.
A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our guide to system prompts.
IReadOnlyList<BetaTextBlockParam>
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
IReadOnlyList<BetaTextCitationParam>? Citations
class BetaCitationCharLocationParam:
class BetaCitationPageLocationParam:
class BetaCitationContentBlockLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationSearchResultLocationParam:
Double TemperatureAmount of randomness injected into the response.
Amount of randomness injected into the response.
Defaults to 1.0. Ranges from 0.0 to 1.0. Use temperature closer to 0.0 for analytical / multiple choice, and closer to 1.0 for creative and generative tasks.
Note that even with temperature of 0.0, the results will not be fully deterministic.
BetaThinkingConfigParam ThinkingConfiguration for enabling Claude's extended thinking.
Configuration for enabling Claude's extended thinking.
When enabled, responses include thinking content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your max_tokens limit.
See extended thinking for details.
class BetaThinkingConfigEnabled:
required Long BudgetTokensDetermines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality.
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.
class BetaThinkingConfigDisabled:
class BetaThinkingConfigAdaptive:
BetaToolChoice ToolChoiceHow 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:The model will automatically decide whether to use tools.
The model will automatically decide whether to use tools.
Boolean DisableParallelToolUseWhether to disable parallel tool use.
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output at most one tool use.
class BetaToolChoiceAny:The model will use any available tools.
The model will use any available tools.
Boolean DisableParallelToolUseWhether to disable parallel tool use.
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
class BetaToolChoiceTool: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.
Boolean DisableParallelToolUseWhether to disable parallel tool use.
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
class BetaToolChoiceNone:The model will not be allowed to use tools.
The model will not be allowed to use tools.
IReadOnlyList<BetaToolUnion> ToolsDefinitions of tools that the model may use.
Definitions of tools that the model may use.
If you include tools in your API request, the model may return tool_use content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using tool_result content blocks.
There are two types of tools: client tools and server tools. The behavior described below applies to client tools. For server tools, see their individual documentation as each has its own behavior (e.g., the web search tool).
Each tool definition includes:
name: Name of the tool.description: Optional, but strongly-recommended description of the tool.input_schema: JSON schema for the toolinputshape that the model will produce intool_useoutput content blocks.
For example, if you defined tools as:
[
{
"name": "get_stock_price",
"description": "Get the current stock price for a given ticker symbol.",
"input_schema": {
"type": "object",
"properties": {
"ticker": {
"type": "string",
"description": "The stock ticker symbol, e.g. AAPL for Apple Inc."
}
},
"required": ["ticker"]
}
}
]
And then asked the model "What's the S&P 500 at today?", the model might produce tool_use content blocks in the response like this:
[
{
"type": "tool_use",
"id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
"name": "get_stock_price",
"input": { "ticker": "^GSPC" }
}
]
You might then run your get_stock_price tool with {"ticker": "^GSPC"} as an input, and return the following back to the model in a subsequent user message:
[
{
"type": "tool_result",
"tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
"content": "259.75 USD"
}
]
Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output.
See our guide for more details.
class BetaTool:
required InputSchema InputSchemaJSON schema for this tool's input.
JSON schema for this tool's input.
This defines the shape of the input that your tool accepts and that the model will produce.
required string NameName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
string DescriptionDescription of what this tool does.
Description of what this tool does.
Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema.
Enable eager input streaming for this tool. When true, tool input parameters will be streamed incrementally as they are generated, and types will be inferred on-the-fly rather than buffering the full JSON output. When false, streaming is disabled for this tool even if the fine-grained-tool-streaming beta is active. When null (default), uses the default behavior based on beta headers.
When true, guarantees schema validation on tool names and inputs
class BetaToolBash20241022:
JsonElement Name "bash"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class BetaToolBash20250124:
JsonElement Name "bash"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class BetaCodeExecutionTool20250522:
JsonElement Name "code_execution"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class BetaCodeExecutionTool20250825:
JsonElement Name "code_execution"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class BetaCodeExecutionTool20260120:Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
JsonElement Name "code_execution"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class BetaToolComputerUse20241022:
The height of the display in pixels.
The width of the display in pixels.
JsonElement Name "computer"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
The X11 display number (e.g. 0, 1) for the display.
When true, guarantees schema validation on tool names and inputs
class BetaMemoryTool20250818:
JsonElement Name "memory"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class BetaToolComputerUse20250124:
The height of the display in pixels.
The width of the display in pixels.
JsonElement Name "computer"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
The X11 display number (e.g. 0, 1) for the display.
When true, guarantees schema validation on tool names and inputs
class BetaToolTextEditor20241022:
JsonElement Name "str_replace_editor"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class BetaToolComputerUse20251124:
The height of the display in pixels.
The width of the display in pixels.
JsonElement Name "computer"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
The X11 display number (e.g. 0, 1) for the display.
Whether to enable an action to take a zoomed-in screenshot of the screen.
When true, guarantees schema validation on tool names and inputs
class BetaToolTextEditor20250124:
JsonElement Name "str_replace_editor"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class BetaToolTextEditor20250429:
JsonElement Name "str_replace_based_edit_tool"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class BetaToolTextEditor20250728:
JsonElement Name "str_replace_based_edit_tool"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.
When true, guarantees schema validation on tool names and inputs
class BetaWebSearchTool20250305:
JsonElement Name "web_search"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
IReadOnlyList<AllowedCaller> AllowedCallers
If provided, only these domains will be included in results. Cannot be used alongside blocked_domains.
If provided, these domains will never appear in results. Cannot be used alongside allowed_domains.
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Maximum number of times the tool can be used in the API request.
When true, guarantees schema validation on tool names and inputs
BetaUserLocation? UserLocationParameters for the user's location. Used to provide more relevant search results.
Parameters for the user's location. Used to provide more relevant search results.
The city of the user.
The two letter ISO country code of the user.
The region of the user.
The IANA timezone of the user.
class BetaWebFetchTool20250910:
JsonElement Name "web_fetch"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
IReadOnlyList<AllowedCaller> AllowedCallers
List of domains to allow fetching from
List of domains to block fetching from
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaCitationsConfigParam? CitationsCitations configuration for fetched documents. Citations are disabled by default.
Citations configuration for fetched documents. Citations are disabled by default.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
Maximum number of times the tool can be used in the API request.
When true, guarantees schema validation on tool names and inputs
class BetaWebSearchTool20260209:
JsonElement Name "web_search"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
IReadOnlyList<AllowedCaller> AllowedCallers
If provided, only these domains will be included in results. Cannot be used alongside blocked_domains.
If provided, these domains will never appear in results. Cannot be used alongside allowed_domains.
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Maximum number of times the tool can be used in the API request.
When true, guarantees schema validation on tool names and inputs
BetaUserLocation? UserLocationParameters for the user's location. Used to provide more relevant search results.
Parameters for the user's location. Used to provide more relevant search results.
The city of the user.
The two letter ISO country code of the user.
The region of the user.
The IANA timezone of the user.
class BetaWebFetchTool20260209:
JsonElement Name "web_fetch"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
IReadOnlyList<AllowedCaller> AllowedCallers
List of domains to allow fetching from
List of domains to block fetching from
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
BetaCitationsConfigParam? CitationsCitations configuration for fetched documents. Citations are disabled by default.
Citations configuration for fetched documents. Citations are disabled by default.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
Maximum number of times the tool can be used in the API request.
When true, guarantees schema validation on tool names and inputs
class BetaToolSearchToolBm25_20251119:
JsonElement Name "tool_search_tool_bm25"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
required Type Type
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class BetaToolSearchToolRegex20251119:
JsonElement Name "tool_search_tool_regex"constantName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
required Type Type
IReadOnlyList<AllowedCaller> AllowedCallers
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class BetaMcpToolset:Configuration for a group of tools from an MCP server.
Configuration for a group of tools from an MCP server.
Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides.
Name of the MCP server to configure tools for
BetaCacheControlEphemeral? CacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Ttl TtlThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
IReadOnlyDictionary<string, BetaMcpToolConfig>? ConfigsConfiguration overrides for specific tools, keyed by tool name
Configuration overrides for specific tools, keyed by tool name
BetaMcpToolDefaultConfig DefaultConfigDefault configuration applied to all tools from this server
Default configuration applied to all tools from this server
Long TopKOnly sample from the top K options for each subsequent token.
Only sample from the top K options for each subsequent token.
Used to remove "long tail" low probability responses. Learn more technical details here.
Recommended for advanced use cases only. You usually only need to use temperature.
Double TopPUse nucleus sampling.
Use nucleus sampling.
In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by top_p. You should either alter temperature or top_p, but not both.
Recommended for advanced use cases only. You usually only need to use temperature.
IReadOnlyList<AnthropicBeta> betasHeader param: Optional header to specify the beta version(s) you want to use.
Header param: Optional header to specify the beta version(s) you want to use.
ReturnsExpand Collapse
class BetaMessageBatch:
required string IDUnique object identifier.
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.
required DateTimeOffset? EndedAtRFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends.
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.
required ProcessingStatus ProcessingStatusProcessing status of the Message Batch.
Processing status of the Message Batch.
required BetaMessageBatchRequestCounts RequestCountsTallies requests within the Message Batch, categorized by their status.
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.
required Long CanceledNumber of requests in the Message Batch that have been canceled.
Number of requests in the Message Batch that have been canceled.
This is zero until processing of the entire Message Batch has ended.
required Long ErroredNumber of requests in the Message Batch that encountered an error.
Number of requests in the Message Batch that encountered an error.
This is zero until processing of the entire Message Batch has ended.
required Long ExpiredNumber of requests in the Message Batch that have expired.
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.
required Long SucceededNumber of requests in the Message Batch that have completed successfully.
Number of requests in the Message Batch that have completed successfully.
This is zero until processing of the entire Message Batch has ended.
required string? ResultsUrlURL to a .jsonl file containing the results of the Message Batch requests. Specified only once processing ends.
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.
JsonElement Type "message_batch"constantObject type.
Object type.
For Message Batches, this is always "message_batch".
BatchCreateParams parameters = new()
{
Requests =
[
new()
{
CustomID = "my-custom-id-1",
Params = new()
{
MaxTokens = 1024,
Messages =
[
new()
{
Content = "Hello, world",
Role = Role.User,
},
],
Model = Model.ClaudeOpus4_6,
CacheControl = new() { Ttl = Ttl.Ttl5m },
Container = new BetaContainerParams()
{
ID = "id",
Skills =
[
new()
{
SkillID = "x",
Type = Type.Anthropic,
Version = "x",
},
],
},
ContextManagement = new()
{
Edits =
[
new BetaClearToolUses20250919Edit()
{
ClearAtLeast = new(0),
ClearToolInputs = true,
ExcludeTools =
[
"string"
],
Keep = new(0),
Trigger = new BetaInputTokensTrigger(1),
},
],
},
InferenceGeo = "inference_geo",
McpServers =
[
new()
{
Name = "name",
Url = "url",
AuthorizationToken = "authorization_token",
ToolConfiguration = new()
{
AllowedTools =
[
"string"
],
Enabled = true,
},
},
],
Metadata = new()
{
UserID = "13803d75-b4b5-4c3e-b2a2-6f21399b021b"
},
OutputConfig = new()
{
Effort = Effort.Low,
Format = new()
{
Schema = new Dictionary<string, JsonElement>()
{
{ "foo", JsonSerializer.SerializeToElement("bar") }
},
},
},
OutputFormat = new()
{
Schema = new Dictionary<string, JsonElement>()
{
{ "foo", JsonSerializer.SerializeToElement("bar") }
},
},
ServiceTier = ServiceTier.Auto,
Speed = Speed.Standard,
StopSequences =
[
"string"
],
Stream = true,
System = new(
[
new BetaTextBlockParam()
{
Text = "Today's date is 2024-06-01.",
CacheControl = new() { Ttl = Ttl.Ttl5m },
Citations =
[
new BetaCitationCharLocationParam()
{
CitedText = "cited_text",
DocumentIndex = 0,
DocumentTitle = "x",
EndCharIndex = 0,
StartCharIndex = 0,
},
],
},
]
),
Temperature = 1,
Thinking = new BetaThinkingConfigEnabled(1024),
ToolChoice = new BetaToolChoiceAuto()
{
DisableParallelToolUse = true
},
Tools =
[
new BetaTool()
{
InputSchema = new()
{
Properties = new Dictionary<string, JsonElement>()
{
{ "location", JsonSerializer.SerializeToElement("bar") },
{ "unit", JsonSerializer.SerializeToElement("bar") },
},
Required =
[
"location"
],
},
Name = "name",
AllowedCallers =
[
AllowedCaller.Direct
],
CacheControl = new() { Ttl = Ttl.Ttl5m },
DeferLoading = true,
Description = "Get the current weather in a given location",
EagerInputStreaming = true,
InputExamples =
[
new Dictionary<string, JsonElement>()
{
{ "foo", JsonSerializer.SerializeToElement("bar") },
},
],
Strict = true,
Type = Type.Custom,
},
],
TopK = 5,
TopP = 0.7,
},
},
],
};
var betaMessageBatch = await client.Beta.Messages.Batches.Create(parameters);
Console.WriteLine(betaMessageBatch);{
"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"
}