Beta
ModelsExpand Collapse
class BetaApiError:
class BetaAuthenticationError:
class BetaBillingError:
class BetaError: A class that can be one of several variants.union
class BetaInvalidRequestError:
class BetaAuthenticationError:
class BetaBillingError:
class BetaPermissionError:
class BetaNotFoundError:
class BetaRateLimitError:
class BetaGatewayTimeoutError:
class BetaApiError:
class BetaOverloadedError:
class BetaErrorResponse:
required BetaError Error
class BetaInvalidRequestError:
class BetaAuthenticationError:
class BetaBillingError:
class BetaPermissionError:
class BetaNotFoundError:
class BetaRateLimitError:
class BetaGatewayTimeoutError:
class BetaApiError:
class BetaOverloadedError:
class BetaGatewayTimeoutError:
class BetaInvalidRequestError:
class BetaNotFoundError:
class BetaOverloadedError:
class BetaPermissionError:
class BetaRateLimitError:
BetaModels
List Models
Get a Model
ModelsExpand Collapse
class BetaModelInfo:
Unique model identifier.
RFC 3339 datetime string representing the time at which the model was released. May be set to an epoch value if the release date is unknown.
A human-readable name for the model.
JsonElement Type "model"constantObject type.
Object type.
For Models, this is always "model".
BetaMessages
Create a Message
Count tokens in a Message
ModelsExpand Collapse
class BetaAllThinkingTurns:
class BetaBase64ImageSource:
required MediaType MediaType
class BetaBase64PdfSource:
class BetaBashCodeExecutionOutputBlock:
class BetaBashCodeExecutionOutputBlockParam:
class BetaBashCodeExecutionResultBlock:
required IReadOnlyList<BetaBashCodeExecutionOutputBlock> Content
class BetaBashCodeExecutionResultBlockParam:
required IReadOnlyList<BetaBashCodeExecutionOutputBlockParam> Content
class BetaBashCodeExecutionToolResultBlock:
required Content Content
class BetaBashCodeExecutionToolResultError:
required ErrorCode ErrorCode
class BetaBashCodeExecutionResultBlock:
required IReadOnlyList<BetaBashCodeExecutionOutputBlock> Content
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 BetaBashCodeExecutionToolResultError:
required ErrorCode ErrorCode
class BetaBashCodeExecutionToolResultErrorParam:
required ErrorCode ErrorCode
class BetaCacheControlEphemeral:
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 BetaCacheCreation:
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
class BetaCitationCharLocation:
class BetaCitationCharLocationParam:
class BetaCitationConfig:
class BetaCitationContentBlockLocation:
class BetaCitationContentBlockLocationParam:
class BetaCitationPageLocation:
class BetaCitationPageLocationParam:
class BetaCitationSearchResultLocation:
class BetaCitationSearchResultLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationsConfigParam:
class BetaCitationsDelta:
required Citation Citation
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaCitationsWebSearchResultLocation:
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 BetaClearThinking20251015EditResponse:
Number of input tokens cleared by this edit.
Number of thinking turns that were cleared.
The type of context management edit applied.
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 BetaClearToolUses20250919EditResponse:
Number of input tokens cleared by this edit.
Number of tool uses that were cleared.
The type of context management edit applied.
class BetaCodeExecutionOutputBlock:
class BetaCodeExecutionOutputBlockParam:
class BetaCodeExecutionResultBlock:
required IReadOnlyList<BetaCodeExecutionOutputBlock> Content
class BetaCodeExecutionResultBlockParam:
required IReadOnlyList<BetaCodeExecutionOutputBlockParam> Content
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 BetaCodeExecutionToolResultBlock:
required BetaCodeExecutionToolResultBlockContent ContentCode execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
class BetaCodeExecutionToolResultError:
required BetaCodeExecutionToolResultErrorCode ErrorCode
class BetaCodeExecutionResultBlock:
required IReadOnlyList<BetaCodeExecutionOutputBlock> Content
class BetaEncryptedCodeExecutionResultBlock:Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
required IReadOnlyList<BetaCodeExecutionOutputBlock> Content
class BetaCodeExecutionToolResultBlockContent: A class that can be one of several variants.union Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
class BetaCodeExecutionToolResultError:
required BetaCodeExecutionToolResultErrorCode ErrorCode
class BetaCodeExecutionResultBlock:
required IReadOnlyList<BetaCodeExecutionOutputBlock> Content
class BetaEncryptedCodeExecutionResultBlock:Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
required IReadOnlyList<BetaCodeExecutionOutputBlock> Content
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 BetaCodeExecutionToolResultBlockParamContent: A class that can be one of several variants.union Code 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
class BetaCodeExecutionToolResultError:
required BetaCodeExecutionToolResultErrorCode ErrorCode
enum BetaCodeExecutionToolResultErrorCode:
class BetaCodeExecutionToolResultErrorParam:
required BetaCodeExecutionToolResultErrorCode ErrorCode
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.
class BetaCompactionBlock:A compaction block returned when autocompact is triggered.
A compaction block returned when autocompact is triggered.
When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops.
Summary of compacted content, or null if compaction failed
class 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.
class BetaCompactionContentBlockDelta:
class BetaCompactionIterationUsage:Token usage for a compaction iteration.
Token usage for a compaction iteration.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a compaction iteration
class BetaContainer:Information about the container used in the request (for the code execution tool)
Information about the container used in the request (for the code execution tool)
Identifier for the container used in this request
The time at which the container will expire.
required IReadOnlyList<BetaSkill>? SkillsSkills loaded in the container
Skills loaded 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
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
class BetaContainerUploadBlock:Response model for a file uploaded to the container.
Response model for a file uploaded to the container.
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 BetaContentBlock: A class that can be one of several variants.union Response model for a file uploaded to the container.
Response model for a file uploaded to the container.
class BetaTextBlock:
required IReadOnlyList<BetaTextCitation>? CitationsCitations supporting the text block.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaThinkingBlock:
class BetaRedactedThinkingBlock:
class BetaToolUseBlock:
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaServerToolUseBlock:
required Name Name
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaWebSearchToolResultBlock:
required BetaWebSearchToolResultBlockContent Content
class BetaWebSearchToolResultError:
required BetaWebSearchToolResultErrorCode ErrorCode
IReadOnlyList<BetaWebSearchResultBlock>
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaWebFetchToolResultBlock:
required Content Content
class BetaWebFetchToolResultErrorBlock:
required BetaWebFetchToolResultErrorCode ErrorCode
class BetaWebFetchBlock:
required BetaDocumentBlock Content
required BetaCitationConfig? CitationsCitation configuration for the document
Citation configuration for the document
required Source Source
class BetaBase64PdfSource:
class BetaPlainTextSource:
The title of the document
ISO 8601 timestamp when the content was retrieved
Fetched content URL
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaCodeExecutionToolResultBlock:
required BetaCodeExecutionToolResultBlockContent ContentCode execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
class BetaCodeExecutionToolResultError:
required BetaCodeExecutionToolResultErrorCode ErrorCode
class BetaCodeExecutionResultBlock:
required IReadOnlyList<BetaCodeExecutionOutputBlock> Content
class BetaEncryptedCodeExecutionResultBlock:Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
required IReadOnlyList<BetaCodeExecutionOutputBlock> Content
class BetaBashCodeExecutionToolResultBlock:
required Content Content
class BetaBashCodeExecutionToolResultError:
required ErrorCode ErrorCode
class BetaBashCodeExecutionResultBlock:
required IReadOnlyList<BetaBashCodeExecutionOutputBlock> Content
class BetaTextEditorCodeExecutionToolResultBlock:
required Content Content
class BetaTextEditorCodeExecutionToolResultError:
required ErrorCode ErrorCode
class BetaTextEditorCodeExecutionViewResultBlock:
required FileType FileType
class BetaTextEditorCodeExecutionCreateResultBlock:
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
class BetaToolSearchToolResultBlock:
required Content Content
class BetaToolSearchToolResultError:
required ErrorCode ErrorCode
class BetaToolSearchToolSearchResultBlock:
required IReadOnlyList<BetaToolReferenceBlock> ToolReferences
class BetaMcpToolUseBlock:
The name of the MCP tool
The name of the MCP server
class BetaMcpToolResultBlock:
required Content Content
IReadOnlyList<BetaTextBlock>
required IReadOnlyList<BetaTextCitation>? CitationsCitations supporting the text block.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaContainerUploadBlock:Response model for a file uploaded to the container.
Response model for a file uploaded to the container.
class BetaCompactionBlock:A compaction block returned when autocompact is triggered.
A compaction block returned when autocompact is triggered.
When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops.
Summary of compacted content, or null if compaction failed
class BetaContentBlockParam: A class that can be one of several variants.union Regular text content.
Regular text content.
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.
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 BetaContentBlockSourceContent: A class that can be one of several variants.union
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 BetaContextManagementConfig:
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.
class BetaContextManagementResponse:
required IReadOnlyList<AppliedEdit> AppliedEditsList of context management edits that were applied.
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse:
Number of input tokens cleared by this edit.
Number of tool uses that were cleared.
The type of context management edit applied.
class BetaClearThinking20251015EditResponse:
Number of input tokens cleared by this edit.
Number of thinking turns that were cleared.
The type of context management edit applied.
class BetaCountTokensContextManagementResponse:
The original token count before context management was applied
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaDocumentBlock:
required BetaCitationConfig? CitationsCitation configuration for the document
Citation configuration for the document
required Source Source
class BetaBase64PdfSource:
class BetaPlainTextSource:
The title of the document
class BetaEncryptedCodeExecutionResultBlock:Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
required IReadOnlyList<BetaCodeExecutionOutputBlock> 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
class BetaFileDocumentSource:
class BetaFileImageSource:
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 BetaInputJsonDelta:
class BetaInputTokensClearAtLeast:
class BetaInputTokensTrigger:
class BetaJsonOutputFormat:
The JSON schema of the format
class BetaMcpToolConfig:Configuration for a specific tool in an MCP toolset.
Configuration for a specific tool in an MCP toolset.
class BetaMcpToolDefaultConfig:Default configuration for tools in an MCP toolset.
Default configuration for tools in an MCP toolset.
class BetaMcpToolResultBlock:
required Content Content
IReadOnlyList<BetaTextBlock>
required IReadOnlyList<BetaTextCitation>? CitationsCitations supporting the text block.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaMcpToolUseBlock:
The name of the MCP tool
The name of the MCP server
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 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
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 BetaMemoryTool20250818Command: A class that can be one of several variants.union
class BetaMemoryTool20250818ViewCommand:
Command type identifier
Path to directory or file to view
Optional line range for viewing specific lines
class BetaMemoryTool20250818CreateCommand:
Command type identifier
Content to write to the file
Path where the file should be created
class BetaMemoryTool20250818StrReplaceCommand:
Command type identifier
Text to replace with
Text to search for and replace
Path to the file where text should be replaced
class BetaMemoryTool20250818InsertCommand:
Command type identifier
Line number where text should be inserted
Text to insert at the specified line
Path to the file where text should be inserted
class BetaMemoryTool20250818DeleteCommand:
Command type identifier
Path to the file or directory to delete
class BetaMemoryTool20250818RenameCommand:
Command type identifier
New path for the file or directory
Current path of the file or directory
class BetaMemoryTool20250818CreateCommand:
Command type identifier
Content to write to the file
Path where the file should be created
class BetaMemoryTool20250818DeleteCommand:
Command type identifier
Path to the file or directory to delete
class BetaMemoryTool20250818InsertCommand:
Command type identifier
Line number where text should be inserted
Text to insert at the specified line
Path to the file where text should be inserted
class BetaMemoryTool20250818RenameCommand:
Command type identifier
New path for the file or directory
Current path of the file or directory
class BetaMemoryTool20250818StrReplaceCommand:
Command type identifier
Text to replace with
Text to search for and replace
Path to the file where text should be replaced
class BetaMemoryTool20250818ViewCommand:
Command type identifier
Path to directory or file to view
Optional line range for viewing specific lines
class BetaMessage:
required string IDUnique object identifier.
Unique object identifier.
The format and length of IDs may change over time.
required BetaContainer? ContainerInformation about the container used in the request (for the code execution tool)
Information about the container used in the request (for the code execution tool)
Identifier for the container used in this request
The time at which the container will expire.
required IReadOnlyList<BetaSkill>? SkillsSkills loaded in the container
Skills loaded 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
required IReadOnlyList<BetaContentBlock> ContentContent generated by the model.
Content generated by the model.
This is an array of content blocks, each of which has a type that determines its shape.
Example:
[{"type": "text", "text": "Hi, I'm Claude."}]
If the request input messages ended with an assistant turn, then the response content will continue directly from that last turn. You can use this to constrain the model's output.
For example, if the input messages were:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("}
]
Then the response content might be:
[{"type": "text", "text": "B)"}]
class BetaTextBlock:
required IReadOnlyList<BetaTextCitation>? CitationsCitations supporting the text block.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaThinkingBlock:
class BetaRedactedThinkingBlock:
class BetaToolUseBlock:
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaServerToolUseBlock:
required Name Name
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaWebSearchToolResultBlock:
required BetaWebSearchToolResultBlockContent Content
class BetaWebSearchToolResultError:
required BetaWebSearchToolResultErrorCode ErrorCode
IReadOnlyList<BetaWebSearchResultBlock>
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaWebFetchToolResultBlock:
required Content Content
class BetaWebFetchToolResultErrorBlock:
required BetaWebFetchToolResultErrorCode ErrorCode
class BetaWebFetchBlock:
required BetaDocumentBlock Content
required BetaCitationConfig? CitationsCitation configuration for the document
Citation configuration for the document
required Source Source
class BetaBase64PdfSource:
class BetaPlainTextSource:
The title of the document
ISO 8601 timestamp when the content was retrieved
Fetched content URL
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaCodeExecutionToolResultBlock:
required BetaCodeExecutionToolResultBlockContent ContentCode execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
class BetaCodeExecutionToolResultError:
required BetaCodeExecutionToolResultErrorCode ErrorCode
class BetaCodeExecutionResultBlock:
required IReadOnlyList<BetaCodeExecutionOutputBlock> Content
class BetaEncryptedCodeExecutionResultBlock:Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
required IReadOnlyList<BetaCodeExecutionOutputBlock> Content
class BetaBashCodeExecutionToolResultBlock:
required Content Content
class BetaBashCodeExecutionToolResultError:
required ErrorCode ErrorCode
class BetaBashCodeExecutionResultBlock:
required IReadOnlyList<BetaBashCodeExecutionOutputBlock> Content
class BetaTextEditorCodeExecutionToolResultBlock:
required Content Content
class BetaTextEditorCodeExecutionToolResultError:
required ErrorCode ErrorCode
class BetaTextEditorCodeExecutionViewResultBlock:
required FileType FileType
class BetaTextEditorCodeExecutionCreateResultBlock:
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
class BetaToolSearchToolResultBlock:
required Content Content
class BetaToolSearchToolResultError:
required ErrorCode ErrorCode
class BetaToolSearchToolSearchResultBlock:
required IReadOnlyList<BetaToolReferenceBlock> ToolReferences
class BetaMcpToolUseBlock:
The name of the MCP tool
The name of the MCP server
class BetaMcpToolResultBlock:
required Content Content
IReadOnlyList<BetaTextBlock>
required IReadOnlyList<BetaTextCitation>? CitationsCitations supporting the text block.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaContainerUploadBlock:Response model for a file uploaded to the container.
Response model for a file uploaded to the container.
class BetaCompactionBlock:A compaction block returned when autocompact is triggered.
A compaction block returned when autocompact is triggered.
When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops.
Summary of compacted content, or null if compaction failed
required BetaContextManagementResponse? ContextManagementContext management response.
Context management response.
Information about context management strategies applied during the request.
required IReadOnlyList<AppliedEdit> AppliedEditsList of context management edits that were applied.
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse:
Number of input tokens cleared by this edit.
Number of tool uses that were cleared.
The type of context management edit applied.
class BetaClearThinking20251015EditResponse:
Number of input tokens cleared by this edit.
Number of thinking turns that were cleared.
The type of context management edit applied.
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
JsonElement Role "assistant"constantConversational role of the generated message.
Conversational role of the generated message.
This will always be "assistant".
required BetaStopReason? StopReasonThe reason that we stopped.
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
required string? StopSequenceWhich custom stop sequence was generated, if any.
Which custom stop sequence was generated, if any.
This value will be a non-null string if one of your custom stop sequences was generated.
JsonElement Type "message"constantObject type.
Object type.
For Messages, this is always "message".
required BetaUsage UsageBilling and rate-limit usage.
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The geographic region where inference was performed for this request.
The number of input tokens which were used.
required IReadOnlyList<BetaIterationsUsageItems>? IterationsPer-iteration token usage breakdown.
Per-iteration token usage breakdown.
Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to:
- Determine which iterations exceeded long context thresholds (>=200k tokens)
- Calculate the true context window size from the last iteration
- Understand token accumulation across server-side tool use loops
class BetaMessageIterationUsage:Token usage for a sampling iteration.
Token usage for a sampling iteration.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a sampling iteration
class BetaCompactionIterationUsage:Token usage for a compaction iteration.
Token usage for a compaction iteration.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a compaction iteration
The number of output tokens which were used.
required BetaServerToolUsage? ServerToolUseThe number of server tool requests.
The number of server tool requests.
The number of web fetch tool requests.
The number of web search tool requests.
required ServiceTier? ServiceTierIf the request used the priority, standard, or batch tier.
If the request used the priority, standard, or batch tier.
required Speed? SpeedThe inference speed mode used for this request.
The inference speed mode used for this request.
class BetaMessageDeltaUsage:
The cumulative number of input tokens used to create the cache entry.
The cumulative number of input tokens read from the cache.
The cumulative number of input tokens which were used.
required IReadOnlyList<BetaIterationsUsageItems>? IterationsPer-iteration token usage breakdown.
Per-iteration token usage breakdown.
Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to:
- Determine which iterations exceeded long context thresholds (>=200k tokens)
- Calculate the true context window size from the last iteration
- Understand token accumulation across server-side tool use loops
class BetaMessageIterationUsage:Token usage for a sampling iteration.
Token usage for a sampling iteration.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a sampling iteration
class BetaCompactionIterationUsage:Token usage for a compaction iteration.
Token usage for a compaction iteration.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a compaction iteration
The cumulative number of output tokens which were used.
required BetaServerToolUsage? ServerToolUseThe number of server tool requests.
The number of server tool requests.
The number of web fetch tool requests.
The number of web search tool requests.
class BetaMessageIterationUsage:Token usage for a sampling iteration.
Token usage for a sampling iteration.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a sampling iteration
class BetaMessageParam:
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
class BetaMessageTokensCount:
required BetaCountTokensContextManagementResponse? ContextManagementInformation about context management applied to the message.
Information about context management applied to the message.
The original token count before context management was applied
The total number of tokens across the provided list of messages, system prompt, and tools.
class BetaMetadata:
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.
class BetaOutputConfig:
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
class BetaPlainTextSource:
class BetaRawContentBlockDelta: A class that can be one of several variants.union
class BetaTextDelta:
class BetaInputJsonDelta:
class BetaCitationsDelta:
required Citation Citation
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaThinkingDelta:
class BetaSignatureDelta:
class BetaCompactionContentBlockDelta:
class BetaRawContentBlockDeltaEvent:
required BetaRawContentBlockDelta Delta
class BetaTextDelta:
class BetaInputJsonDelta:
class BetaCitationsDelta:
required Citation Citation
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaThinkingDelta:
class BetaSignatureDelta:
class BetaCompactionContentBlockDelta:
class BetaRawContentBlockStartEvent:
required ContentBlock ContentBlockResponse model for a file uploaded to the container.
Response model for a file uploaded to the container.
class BetaTextBlock:
required IReadOnlyList<BetaTextCitation>? CitationsCitations supporting the text block.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaThinkingBlock:
class BetaRedactedThinkingBlock:
class BetaToolUseBlock:
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaServerToolUseBlock:
required Name Name
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaWebSearchToolResultBlock:
required BetaWebSearchToolResultBlockContent Content
class BetaWebSearchToolResultError:
required BetaWebSearchToolResultErrorCode ErrorCode
IReadOnlyList<BetaWebSearchResultBlock>
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaWebFetchToolResultBlock:
required Content Content
class BetaWebFetchToolResultErrorBlock:
required BetaWebFetchToolResultErrorCode ErrorCode
class BetaWebFetchBlock:
required BetaDocumentBlock Content
required BetaCitationConfig? CitationsCitation configuration for the document
Citation configuration for the document
required Source Source
class BetaBase64PdfSource:
class BetaPlainTextSource:
The title of the document
ISO 8601 timestamp when the content was retrieved
Fetched content URL
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaCodeExecutionToolResultBlock:
required BetaCodeExecutionToolResultBlockContent ContentCode execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
class BetaCodeExecutionToolResultError:
required BetaCodeExecutionToolResultErrorCode ErrorCode
class BetaCodeExecutionResultBlock:
required IReadOnlyList<BetaCodeExecutionOutputBlock> Content
class BetaEncryptedCodeExecutionResultBlock:Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
required IReadOnlyList<BetaCodeExecutionOutputBlock> Content
class BetaBashCodeExecutionToolResultBlock:
required Content Content
class BetaBashCodeExecutionToolResultError:
required ErrorCode ErrorCode
class BetaBashCodeExecutionResultBlock:
required IReadOnlyList<BetaBashCodeExecutionOutputBlock> Content
class BetaTextEditorCodeExecutionToolResultBlock:
required Content Content
class BetaTextEditorCodeExecutionToolResultError:
required ErrorCode ErrorCode
class BetaTextEditorCodeExecutionViewResultBlock:
required FileType FileType
class BetaTextEditorCodeExecutionCreateResultBlock:
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
class BetaToolSearchToolResultBlock:
required Content Content
class BetaToolSearchToolResultError:
required ErrorCode ErrorCode
class BetaToolSearchToolSearchResultBlock:
required IReadOnlyList<BetaToolReferenceBlock> ToolReferences
class BetaMcpToolUseBlock:
The name of the MCP tool
The name of the MCP server
class BetaMcpToolResultBlock:
required Content Content
IReadOnlyList<BetaTextBlock>
required IReadOnlyList<BetaTextCitation>? CitationsCitations supporting the text block.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaContainerUploadBlock:Response model for a file uploaded to the container.
Response model for a file uploaded to the container.
class BetaCompactionBlock:A compaction block returned when autocompact is triggered.
A compaction block returned when autocompact is triggered.
When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops.
Summary of compacted content, or null if compaction failed
class BetaRawContentBlockStopEvent:
class BetaRawMessageDeltaEvent:
required BetaContextManagementResponse? ContextManagementInformation about context management strategies applied during the request
Information about context management strategies applied during the request
required IReadOnlyList<AppliedEdit> AppliedEditsList of context management edits that were applied.
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse:
Number of input tokens cleared by this edit.
Number of tool uses that were cleared.
The type of context management edit applied.
class BetaClearThinking20251015EditResponse:
Number of input tokens cleared by this edit.
Number of thinking turns that were cleared.
The type of context management edit applied.
required Delta Delta
required BetaContainer? ContainerInformation about the container used in the request (for the code execution tool)
Information about the container used in the request (for the code execution tool)
Identifier for the container used in this request
The time at which the container will expire.
required IReadOnlyList<BetaSkill>? SkillsSkills loaded in the container
Skills loaded 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
required BetaStopReason? StopReason
required BetaMessageDeltaUsage UsageBilling and rate-limit usage.
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
The cumulative number of input tokens used to create the cache entry.
The cumulative number of input tokens read from the cache.
The cumulative number of input tokens which were used.
required IReadOnlyList<BetaIterationsUsageItems>? IterationsPer-iteration token usage breakdown.
Per-iteration token usage breakdown.
Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to:
- Determine which iterations exceeded long context thresholds (>=200k tokens)
- Calculate the true context window size from the last iteration
- Understand token accumulation across server-side tool use loops
class BetaMessageIterationUsage:Token usage for a sampling iteration.
Token usage for a sampling iteration.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a sampling iteration
class BetaCompactionIterationUsage:Token usage for a compaction iteration.
Token usage for a compaction iteration.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a compaction iteration
The cumulative number of output tokens which were used.
required BetaServerToolUsage? ServerToolUseThe number of server tool requests.
The number of server tool requests.
The number of web fetch tool requests.
The number of web search tool requests.
class BetaRawMessageStartEvent:
required BetaMessage Message
required string IDUnique object identifier.
Unique object identifier.
The format and length of IDs may change over time.
required BetaContainer? ContainerInformation about the container used in the request (for the code execution tool)
Information about the container used in the request (for the code execution tool)
Identifier for the container used in this request
The time at which the container will expire.
required IReadOnlyList<BetaSkill>? SkillsSkills loaded in the container
Skills loaded 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
required IReadOnlyList<BetaContentBlock> ContentContent generated by the model.
Content generated by the model.
This is an array of content blocks, each of which has a type that determines its shape.
Example:
[{"type": "text", "text": "Hi, I'm Claude."}]
If the request input messages ended with an assistant turn, then the response content will continue directly from that last turn. You can use this to constrain the model's output.
For example, if the input messages were:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("}
]
Then the response content might be:
[{"type": "text", "text": "B)"}]
class BetaTextBlock:
required IReadOnlyList<BetaTextCitation>? CitationsCitations supporting the text block.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaThinkingBlock:
class BetaRedactedThinkingBlock:
class BetaToolUseBlock:
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaServerToolUseBlock:
required Name Name
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaWebSearchToolResultBlock:
required BetaWebSearchToolResultBlockContent Content
class BetaWebSearchToolResultError:
required BetaWebSearchToolResultErrorCode ErrorCode
IReadOnlyList<BetaWebSearchResultBlock>
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaWebFetchToolResultBlock:
required Content Content
class BetaWebFetchToolResultErrorBlock:
required BetaWebFetchToolResultErrorCode ErrorCode
class BetaWebFetchBlock:
required BetaDocumentBlock Content
required BetaCitationConfig? CitationsCitation configuration for the document
Citation configuration for the document
required Source Source
class BetaBase64PdfSource:
class BetaPlainTextSource:
The title of the document
ISO 8601 timestamp when the content was retrieved
Fetched content URL
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaCodeExecutionToolResultBlock:
required BetaCodeExecutionToolResultBlockContent ContentCode execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
class BetaCodeExecutionToolResultError:
required BetaCodeExecutionToolResultErrorCode ErrorCode
class BetaCodeExecutionResultBlock:
required IReadOnlyList<BetaCodeExecutionOutputBlock> Content
class BetaEncryptedCodeExecutionResultBlock:Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
required IReadOnlyList<BetaCodeExecutionOutputBlock> Content
class BetaBashCodeExecutionToolResultBlock:
required Content Content
class BetaBashCodeExecutionToolResultError:
required ErrorCode ErrorCode
class BetaBashCodeExecutionResultBlock:
required IReadOnlyList<BetaBashCodeExecutionOutputBlock> Content
class BetaTextEditorCodeExecutionToolResultBlock:
required Content Content
class BetaTextEditorCodeExecutionToolResultError:
required ErrorCode ErrorCode
class BetaTextEditorCodeExecutionViewResultBlock:
required FileType FileType
class BetaTextEditorCodeExecutionCreateResultBlock:
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
class BetaToolSearchToolResultBlock:
required Content Content
class BetaToolSearchToolResultError:
required ErrorCode ErrorCode
class BetaToolSearchToolSearchResultBlock:
required IReadOnlyList<BetaToolReferenceBlock> ToolReferences
class BetaMcpToolUseBlock:
The name of the MCP tool
The name of the MCP server
class BetaMcpToolResultBlock:
required Content Content
IReadOnlyList<BetaTextBlock>
required IReadOnlyList<BetaTextCitation>? CitationsCitations supporting the text block.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaContainerUploadBlock:Response model for a file uploaded to the container.
Response model for a file uploaded to the container.
class BetaCompactionBlock:A compaction block returned when autocompact is triggered.
A compaction block returned when autocompact is triggered.
When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops.
Summary of compacted content, or null if compaction failed
required BetaContextManagementResponse? ContextManagementContext management response.
Context management response.
Information about context management strategies applied during the request.
required IReadOnlyList<AppliedEdit> AppliedEditsList of context management edits that were applied.
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse:
Number of input tokens cleared by this edit.
Number of tool uses that were cleared.
The type of context management edit applied.
class BetaClearThinking20251015EditResponse:
Number of input tokens cleared by this edit.
Number of thinking turns that were cleared.
The type of context management edit applied.
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
JsonElement Role "assistant"constantConversational role of the generated message.
Conversational role of the generated message.
This will always be "assistant".
required BetaStopReason? StopReasonThe reason that we stopped.
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
required string? StopSequenceWhich custom stop sequence was generated, if any.
Which custom stop sequence was generated, if any.
This value will be a non-null string if one of your custom stop sequences was generated.
JsonElement Type "message"constantObject type.
Object type.
For Messages, this is always "message".
required BetaUsage UsageBilling and rate-limit usage.
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The geographic region where inference was performed for this request.
The number of input tokens which were used.
required IReadOnlyList<BetaIterationsUsageItems>? IterationsPer-iteration token usage breakdown.
Per-iteration token usage breakdown.
Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to:
- Determine which iterations exceeded long context thresholds (>=200k tokens)
- Calculate the true context window size from the last iteration
- Understand token accumulation across server-side tool use loops
class BetaMessageIterationUsage:Token usage for a sampling iteration.
Token usage for a sampling iteration.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a sampling iteration
class BetaCompactionIterationUsage:Token usage for a compaction iteration.
Token usage for a compaction iteration.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a compaction iteration
The number of output tokens which were used.
required BetaServerToolUsage? ServerToolUseThe number of server tool requests.
The number of server tool requests.
The number of web fetch tool requests.
The number of web search tool requests.
required ServiceTier? ServiceTierIf the request used the priority, standard, or batch tier.
If the request used the priority, standard, or batch tier.
required Speed? SpeedThe inference speed mode used for this request.
The inference speed mode used for this request.
class BetaRawMessageStopEvent:
class BetaRawMessageStreamEvent: A class that can be one of several variants.union
class BetaRawMessageStartEvent:
required BetaMessage Message
required string IDUnique object identifier.
Unique object identifier.
The format and length of IDs may change over time.
required BetaContainer? ContainerInformation about the container used in the request (for the code execution tool)
Information about the container used in the request (for the code execution tool)
Identifier for the container used in this request
The time at which the container will expire.
required IReadOnlyList<BetaSkill>? SkillsSkills loaded in the container
Skills loaded 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
required IReadOnlyList<BetaContentBlock> ContentContent generated by the model.
Content generated by the model.
This is an array of content blocks, each of which has a type that determines its shape.
Example:
[{"type": "text", "text": "Hi, I'm Claude."}]
If the request input messages ended with an assistant turn, then the response content will continue directly from that last turn. You can use this to constrain the model's output.
For example, if the input messages were:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("}
]
Then the response content might be:
[{"type": "text", "text": "B)"}]
class BetaTextBlock:
required IReadOnlyList<BetaTextCitation>? CitationsCitations supporting the text block.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaThinkingBlock:
class BetaRedactedThinkingBlock:
class BetaToolUseBlock:
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaServerToolUseBlock:
required Name Name
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaWebSearchToolResultBlock:
required BetaWebSearchToolResultBlockContent Content
class BetaWebSearchToolResultError:
required BetaWebSearchToolResultErrorCode ErrorCode
IReadOnlyList<BetaWebSearchResultBlock>
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaWebFetchToolResultBlock:
required Content Content
class BetaWebFetchToolResultErrorBlock:
required BetaWebFetchToolResultErrorCode ErrorCode
class BetaWebFetchBlock:
required BetaDocumentBlock Content
required BetaCitationConfig? CitationsCitation configuration for the document
Citation configuration for the document
required Source Source
class BetaBase64PdfSource:
class BetaPlainTextSource:
The title of the document
ISO 8601 timestamp when the content was retrieved
Fetched content URL
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaCodeExecutionToolResultBlock:
required BetaCodeExecutionToolResultBlockContent ContentCode execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
class BetaCodeExecutionToolResultError:
required BetaCodeExecutionToolResultErrorCode ErrorCode
class BetaCodeExecutionResultBlock:
required IReadOnlyList<BetaCodeExecutionOutputBlock> Content
class BetaEncryptedCodeExecutionResultBlock:Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
required IReadOnlyList<BetaCodeExecutionOutputBlock> Content
class BetaBashCodeExecutionToolResultBlock:
required Content Content
class BetaBashCodeExecutionToolResultError:
required ErrorCode ErrorCode
class BetaBashCodeExecutionResultBlock:
required IReadOnlyList<BetaBashCodeExecutionOutputBlock> Content
class BetaTextEditorCodeExecutionToolResultBlock:
required Content Content
class BetaTextEditorCodeExecutionToolResultError:
required ErrorCode ErrorCode
class BetaTextEditorCodeExecutionViewResultBlock:
required FileType FileType
class BetaTextEditorCodeExecutionCreateResultBlock:
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
class BetaToolSearchToolResultBlock:
required Content Content
class BetaToolSearchToolResultError:
required ErrorCode ErrorCode
class BetaToolSearchToolSearchResultBlock:
required IReadOnlyList<BetaToolReferenceBlock> ToolReferences
class BetaMcpToolUseBlock:
The name of the MCP tool
The name of the MCP server
class BetaMcpToolResultBlock:
required Content Content
IReadOnlyList<BetaTextBlock>
required IReadOnlyList<BetaTextCitation>? CitationsCitations supporting the text block.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaContainerUploadBlock:Response model for a file uploaded to the container.
Response model for a file uploaded to the container.
class BetaCompactionBlock:A compaction block returned when autocompact is triggered.
A compaction block returned when autocompact is triggered.
When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops.
Summary of compacted content, or null if compaction failed
required BetaContextManagementResponse? ContextManagementContext management response.
Context management response.
Information about context management strategies applied during the request.
required IReadOnlyList<AppliedEdit> AppliedEditsList of context management edits that were applied.
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse:
Number of input tokens cleared by this edit.
Number of tool uses that were cleared.
The type of context management edit applied.
class BetaClearThinking20251015EditResponse:
Number of input tokens cleared by this edit.
Number of thinking turns that were cleared.
The type of context management edit applied.
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
JsonElement Role "assistant"constantConversational role of the generated message.
Conversational role of the generated message.
This will always be "assistant".
required BetaStopReason? StopReasonThe reason that we stopped.
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
required string? StopSequenceWhich custom stop sequence was generated, if any.
Which custom stop sequence was generated, if any.
This value will be a non-null string if one of your custom stop sequences was generated.
JsonElement Type "message"constantObject type.
Object type.
For Messages, this is always "message".
required BetaUsage UsageBilling and rate-limit usage.
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The geographic region where inference was performed for this request.
The number of input tokens which were used.
required IReadOnlyList<BetaIterationsUsageItems>? IterationsPer-iteration token usage breakdown.
Per-iteration token usage breakdown.
Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to:
- Determine which iterations exceeded long context thresholds (>=200k tokens)
- Calculate the true context window size from the last iteration
- Understand token accumulation across server-side tool use loops
class BetaMessageIterationUsage:Token usage for a sampling iteration.
Token usage for a sampling iteration.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a sampling iteration
class BetaCompactionIterationUsage:Token usage for a compaction iteration.
Token usage for a compaction iteration.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a compaction iteration
The number of output tokens which were used.
required BetaServerToolUsage? ServerToolUseThe number of server tool requests.
The number of server tool requests.
The number of web fetch tool requests.
The number of web search tool requests.
required ServiceTier? ServiceTierIf the request used the priority, standard, or batch tier.
If the request used the priority, standard, or batch tier.
required Speed? SpeedThe inference speed mode used for this request.
The inference speed mode used for this request.
class BetaRawMessageDeltaEvent:
required BetaContextManagementResponse? ContextManagementInformation about context management strategies applied during the request
Information about context management strategies applied during the request
required IReadOnlyList<AppliedEdit> AppliedEditsList of context management edits that were applied.
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse:
Number of input tokens cleared by this edit.
Number of tool uses that were cleared.
The type of context management edit applied.
class BetaClearThinking20251015EditResponse:
Number of input tokens cleared by this edit.
Number of thinking turns that were cleared.
The type of context management edit applied.
required Delta Delta
required BetaContainer? ContainerInformation about the container used in the request (for the code execution tool)
Information about the container used in the request (for the code execution tool)
Identifier for the container used in this request
The time at which the container will expire.
required IReadOnlyList<BetaSkill>? SkillsSkills loaded in the container
Skills loaded 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
required BetaStopReason? StopReason
required BetaMessageDeltaUsage UsageBilling and rate-limit usage.
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
The cumulative number of input tokens used to create the cache entry.
The cumulative number of input tokens read from the cache.
The cumulative number of input tokens which were used.
required IReadOnlyList<BetaIterationsUsageItems>? IterationsPer-iteration token usage breakdown.
Per-iteration token usage breakdown.
Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to:
- Determine which iterations exceeded long context thresholds (>=200k tokens)
- Calculate the true context window size from the last iteration
- Understand token accumulation across server-side tool use loops
class BetaMessageIterationUsage:Token usage for a sampling iteration.
Token usage for a sampling iteration.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a sampling iteration
class BetaCompactionIterationUsage:Token usage for a compaction iteration.
Token usage for a compaction iteration.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a compaction iteration
The cumulative number of output tokens which were used.
required BetaServerToolUsage? ServerToolUseThe number of server tool requests.
The number of server tool requests.
The number of web fetch tool requests.
The number of web search tool requests.
class BetaRawMessageStopEvent:
class BetaRawContentBlockStartEvent:
required ContentBlock ContentBlockResponse model for a file uploaded to the container.
Response model for a file uploaded to the container.
class BetaTextBlock:
required IReadOnlyList<BetaTextCitation>? CitationsCitations supporting the text block.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaThinkingBlock:
class BetaRedactedThinkingBlock:
class BetaToolUseBlock:
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaServerToolUseBlock:
required Name Name
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaWebSearchToolResultBlock:
required BetaWebSearchToolResultBlockContent Content
class BetaWebSearchToolResultError:
required BetaWebSearchToolResultErrorCode ErrorCode
IReadOnlyList<BetaWebSearchResultBlock>
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaWebFetchToolResultBlock:
required Content Content
class BetaWebFetchToolResultErrorBlock:
required BetaWebFetchToolResultErrorCode ErrorCode
class BetaWebFetchBlock:
required BetaDocumentBlock Content
required BetaCitationConfig? CitationsCitation configuration for the document
Citation configuration for the document
required Source Source
class BetaBase64PdfSource:
class BetaPlainTextSource:
The title of the document
ISO 8601 timestamp when the content was retrieved
Fetched content URL
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaCodeExecutionToolResultBlock:
required BetaCodeExecutionToolResultBlockContent ContentCode execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
class BetaCodeExecutionToolResultError:
required BetaCodeExecutionToolResultErrorCode ErrorCode
class BetaCodeExecutionResultBlock:
required IReadOnlyList<BetaCodeExecutionOutputBlock> Content
class BetaEncryptedCodeExecutionResultBlock:Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
required IReadOnlyList<BetaCodeExecutionOutputBlock> Content
class BetaBashCodeExecutionToolResultBlock:
required Content Content
class BetaBashCodeExecutionToolResultError:
required ErrorCode ErrorCode
class BetaBashCodeExecutionResultBlock:
required IReadOnlyList<BetaBashCodeExecutionOutputBlock> Content
class BetaTextEditorCodeExecutionToolResultBlock:
required Content Content
class BetaTextEditorCodeExecutionToolResultError:
required ErrorCode ErrorCode
class BetaTextEditorCodeExecutionViewResultBlock:
required FileType FileType
class BetaTextEditorCodeExecutionCreateResultBlock:
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
class BetaToolSearchToolResultBlock:
required Content Content
class BetaToolSearchToolResultError:
required ErrorCode ErrorCode
class BetaToolSearchToolSearchResultBlock:
required IReadOnlyList<BetaToolReferenceBlock> ToolReferences
class BetaMcpToolUseBlock:
The name of the MCP tool
The name of the MCP server
class BetaMcpToolResultBlock:
required Content Content
IReadOnlyList<BetaTextBlock>
required IReadOnlyList<BetaTextCitation>? CitationsCitations supporting the text block.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaContainerUploadBlock:Response model for a file uploaded to the container.
Response model for a file uploaded to the container.
class BetaCompactionBlock:A compaction block returned when autocompact is triggered.
A compaction block returned when autocompact is triggered.
When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops.
Summary of compacted content, or null if compaction failed
class BetaRawContentBlockDeltaEvent:
required BetaRawContentBlockDelta Delta
class BetaTextDelta:
class BetaInputJsonDelta:
class BetaCitationsDelta:
required Citation Citation
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaThinkingDelta:
class BetaSignatureDelta:
class BetaCompactionContentBlockDelta:
class BetaRawContentBlockStopEvent:
class BetaRedactedThinkingBlock:
class BetaRedactedThinkingBlockParam:
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 BetaRequestMcpServerToolConfiguration:
class BetaRequestMcpServerUrlDefinition:
BetaRequestMcpServerToolConfiguration? ToolConfiguration
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 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 BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaServerToolUsage:
The number of web fetch tool requests.
The number of web search tool requests.
class BetaServerToolUseBlock:
required Name Name
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 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 BetaSignatureDelta:
class BetaSkill:A skill that was loaded in a container (response model).
A skill that was loaded in a container (response model).
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
class BetaSkillParams:Specification for a skill to be loaded in a container (request model).
Specification for a skill to be loaded in a container (request model).
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
enum BetaStopReason:
class BetaTextBlock:
required IReadOnlyList<BetaTextCitation>? CitationsCitations supporting the text block.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class 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 BetaTextCitation: A class that can be one of several variants.union
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaTextCitationParam: A class that can be one of several variants.union
class BetaCitationCharLocationParam:
class BetaCitationPageLocationParam:
class BetaCitationContentBlockLocationParam:
class BetaCitationWebSearchResultLocationParam:
class BetaCitationSearchResultLocationParam:
class BetaTextDelta:
class BetaTextEditorCodeExecutionCreateResultBlock:
class BetaTextEditorCodeExecutionCreateResultBlockParam:
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
class BetaTextEditorCodeExecutionStrReplaceResultBlockParam:
class BetaTextEditorCodeExecutionToolResultBlock:
required Content Content
class BetaTextEditorCodeExecutionToolResultError:
required ErrorCode ErrorCode
class BetaTextEditorCodeExecutionViewResultBlock:
required FileType FileType
class BetaTextEditorCodeExecutionCreateResultBlock:
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
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 BetaTextEditorCodeExecutionToolResultError:
required ErrorCode ErrorCode
class BetaTextEditorCodeExecutionToolResultErrorParam:
required ErrorCode ErrorCode
class BetaTextEditorCodeExecutionViewResultBlock:
required FileType FileType
class BetaTextEditorCodeExecutionViewResultBlockParam:
required FileType FileType
class BetaThinkingBlock:
class BetaThinkingBlockParam:
class BetaThinkingConfigAdaptive:
class BetaThinkingConfigDisabled:
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 BetaThinkingConfigParam: A class that can be one of several variants.union Configuration 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:
class BetaThinkingDelta:
class BetaThinkingTurns:
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 BetaToolChoice: A class that can be one of several variants.union 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: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.
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 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 BetaToolChoiceNone:The model will not be allowed to use tools.
The model will not be allowed to use tools.
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 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 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 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 BetaToolReferenceBlock:
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 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 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 BetaToolSearchToolResultBlock:
required Content Content
class BetaToolSearchToolResultError:
required ErrorCode ErrorCode
class BetaToolSearchToolSearchResultBlock:
required IReadOnlyList<BetaToolReferenceBlock> ToolReferences
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 BetaToolSearchToolResultError:
required ErrorCode ErrorCode
class BetaToolSearchToolResultErrorParam:
required ErrorCode ErrorCode
class BetaToolSearchToolSearchResultBlock:
required IReadOnlyList<BetaToolReferenceBlock> ToolReferences
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.
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 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 BetaToolUnion: A class that can be one of several variants.union Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
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
class BetaToolUseBlock:
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 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 BetaToolUsesKeep:
class BetaToolUsesTrigger:
class BetaUrlImageSource:
class BetaUrlPdfSource:
class BetaUsage:
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The geographic region where inference was performed for this request.
The number of input tokens which were used.
required IReadOnlyList<BetaIterationsUsageItems>? IterationsPer-iteration token usage breakdown.
Per-iteration token usage breakdown.
Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to:
- Determine which iterations exceeded long context thresholds (>=200k tokens)
- Calculate the true context window size from the last iteration
- Understand token accumulation across server-side tool use loops
class BetaMessageIterationUsage:Token usage for a sampling iteration.
Token usage for a sampling iteration.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a sampling iteration
class BetaCompactionIterationUsage:Token usage for a compaction iteration.
Token usage for a compaction iteration.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a compaction iteration
The number of output tokens which were used.
required BetaServerToolUsage? ServerToolUseThe number of server tool requests.
The number of server tool requests.
The number of web fetch tool requests.
The number of web search tool requests.
required ServiceTier? ServiceTierIf the request used the priority, standard, or batch tier.
If the request used the priority, standard, or batch tier.
required Speed? SpeedThe inference speed mode used for this request.
The inference speed mode used for this request.
class BetaUserLocation:
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 BetaWebFetchBlock:
required BetaDocumentBlock Content
required BetaCitationConfig? CitationsCitation configuration for the document
Citation configuration for the document
required Source Source
class BetaBase64PdfSource:
class BetaPlainTextSource:
The title of the document
ISO 8601 timestamp when the content was retrieved
Fetched content URL
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
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 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 BetaWebFetchToolResultBlock:
required Content Content
class BetaWebFetchToolResultErrorBlock:
required BetaWebFetchToolResultErrorCode ErrorCode
class BetaWebFetchBlock:
required BetaDocumentBlock Content
required BetaCitationConfig? CitationsCitation configuration for the document
Citation configuration for the document
required Source Source
class BetaBase64PdfSource:
class BetaPlainTextSource:
The title of the document
ISO 8601 timestamp when the content was retrieved
Fetched content URL
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 BetaWebFetchToolResultErrorBlock:
required BetaWebFetchToolResultErrorCode ErrorCode
class BetaWebFetchToolResultErrorBlockParam:
required BetaWebFetchToolResultErrorCode ErrorCode
enum BetaWebFetchToolResultErrorCode:
class BetaWebSearchResultBlock:
class BetaWebSearchResultBlockParam:
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 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 BetaWebSearchToolRequestError:
required BetaWebSearchToolResultErrorCode ErrorCode
class BetaWebSearchToolResultBlock:
required BetaWebSearchToolResultBlockContent Content
class BetaWebSearchToolResultError:
required BetaWebSearchToolResultErrorCode ErrorCode
IReadOnlyList<BetaWebSearchResultBlock>
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 BetaWebSearchToolResultBlockContent: A class that can be one of several variants.union
class BetaWebSearchToolResultError:
required BetaWebSearchToolResultErrorCode ErrorCode
IReadOnlyList<BetaWebSearchResultBlock>
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 BetaWebSearchToolResultBlockParamContent: A class that can be one of several variants.union
IReadOnlyList<BetaWebSearchResultBlockParam>
class BetaWebSearchToolRequestError:
required BetaWebSearchToolResultErrorCode ErrorCode
class BetaWebSearchToolResultError:
required BetaWebSearchToolResultErrorCode ErrorCode
enum BetaWebSearchToolResultErrorCode:
BetaMessagesBatches
Create a Message Batch
Retrieve a Message Batch
List Message Batches
Cancel a Message Batch
Delete a Message Batch
Retrieve Message Batch results
ModelsExpand Collapse
class BetaDeletedMessageBatch:
ID of the Message Batch.
JsonElement Type "message_batch_deleted"constantDeleted object type.
Deleted object type.
For Message Batches, this is always "message_batch_deleted".
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".
class BetaMessageBatchCanceledResult:
class BetaMessageBatchErroredResult:
required BetaErrorResponse Error
required BetaError Error
class BetaInvalidRequestError:
class BetaAuthenticationError:
class BetaBillingError:
class BetaPermissionError:
class BetaNotFoundError:
class BetaRateLimitError:
class BetaGatewayTimeoutError:
class BetaApiError:
class BetaOverloadedError:
class BetaMessageBatchExpiredResult:
class BetaMessageBatchIndividualResponse:This is a single line in the response .jsonl file and does not represent the response as a whole.
This is a single line in the response .jsonl file and does not represent the response as a whole.
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 BetaMessageBatchResult ResultProcessing result for this request.
Processing result for this request.
Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration.
class BetaMessageBatchSucceededResult:
required BetaMessage Message
required string IDUnique object identifier.
Unique object identifier.
The format and length of IDs may change over time.
required BetaContainer? ContainerInformation about the container used in the request (for the code execution tool)
Information about the container used in the request (for the code execution tool)
Identifier for the container used in this request
The time at which the container will expire.
required IReadOnlyList<BetaSkill>? SkillsSkills loaded in the container
Skills loaded 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
required IReadOnlyList<BetaContentBlock> ContentContent generated by the model.
Content generated by the model.
This is an array of content blocks, each of which has a type that determines its shape.
Example:
[{"type": "text", "text": "Hi, I'm Claude."}]
If the request input messages ended with an assistant turn, then the response content will continue directly from that last turn. You can use this to constrain the model's output.
For example, if the input messages were:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("}
]
Then the response content might be:
[{"type": "text", "text": "B)"}]
class BetaTextBlock:
required IReadOnlyList<BetaTextCitation>? CitationsCitations supporting the text block.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaThinkingBlock:
class BetaRedactedThinkingBlock:
class BetaToolUseBlock:
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaServerToolUseBlock:
required Name Name
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaWebSearchToolResultBlock:
required BetaWebSearchToolResultBlockContent Content
class BetaWebSearchToolResultError:
required BetaWebSearchToolResultErrorCode ErrorCode
IReadOnlyList<BetaWebSearchResultBlock>
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaWebFetchToolResultBlock:
required Content Content
class BetaWebFetchToolResultErrorBlock:
required BetaWebFetchToolResultErrorCode ErrorCode
class BetaWebFetchBlock:
required BetaDocumentBlock Content
required BetaCitationConfig? CitationsCitation configuration for the document
Citation configuration for the document
required Source Source
class BetaBase64PdfSource:
class BetaPlainTextSource:
The title of the document
ISO 8601 timestamp when the content was retrieved
Fetched content URL
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaCodeExecutionToolResultBlock:
required BetaCodeExecutionToolResultBlockContent ContentCode execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
class BetaCodeExecutionToolResultError:
required BetaCodeExecutionToolResultErrorCode ErrorCode
class BetaCodeExecutionResultBlock:
required IReadOnlyList<BetaCodeExecutionOutputBlock> Content
class BetaEncryptedCodeExecutionResultBlock:Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
required IReadOnlyList<BetaCodeExecutionOutputBlock> Content
class BetaBashCodeExecutionToolResultBlock:
required Content Content
class BetaBashCodeExecutionToolResultError:
required ErrorCode ErrorCode
class BetaBashCodeExecutionResultBlock:
required IReadOnlyList<BetaBashCodeExecutionOutputBlock> Content
class BetaTextEditorCodeExecutionToolResultBlock:
required Content Content
class BetaTextEditorCodeExecutionToolResultError:
required ErrorCode ErrorCode
class BetaTextEditorCodeExecutionViewResultBlock:
required FileType FileType
class BetaTextEditorCodeExecutionCreateResultBlock:
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
class BetaToolSearchToolResultBlock:
required Content Content
class BetaToolSearchToolResultError:
required ErrorCode ErrorCode
class BetaToolSearchToolSearchResultBlock:
required IReadOnlyList<BetaToolReferenceBlock> ToolReferences
class BetaMcpToolUseBlock:
The name of the MCP tool
The name of the MCP server
class BetaMcpToolResultBlock:
required Content Content
IReadOnlyList<BetaTextBlock>
required IReadOnlyList<BetaTextCitation>? CitationsCitations supporting the text block.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaContainerUploadBlock:Response model for a file uploaded to the container.
Response model for a file uploaded to the container.
class BetaCompactionBlock:A compaction block returned when autocompact is triggered.
A compaction block returned when autocompact is triggered.
When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops.
Summary of compacted content, or null if compaction failed
required BetaContextManagementResponse? ContextManagementContext management response.
Context management response.
Information about context management strategies applied during the request.
required IReadOnlyList<AppliedEdit> AppliedEditsList of context management edits that were applied.
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse:
Number of input tokens cleared by this edit.
Number of tool uses that were cleared.
The type of context management edit applied.
class BetaClearThinking20251015EditResponse:
Number of input tokens cleared by this edit.
Number of thinking turns that were cleared.
The type of context management edit applied.
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
JsonElement Role "assistant"constantConversational role of the generated message.
Conversational role of the generated message.
This will always be "assistant".
required BetaStopReason? StopReasonThe reason that we stopped.
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
required string? StopSequenceWhich custom stop sequence was generated, if any.
Which custom stop sequence was generated, if any.
This value will be a non-null string if one of your custom stop sequences was generated.
JsonElement Type "message"constantObject type.
Object type.
For Messages, this is always "message".
required BetaUsage UsageBilling and rate-limit usage.
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The geographic region where inference was performed for this request.
The number of input tokens which were used.
required IReadOnlyList<BetaIterationsUsageItems>? IterationsPer-iteration token usage breakdown.
Per-iteration token usage breakdown.
Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to:
- Determine which iterations exceeded long context thresholds (>=200k tokens)
- Calculate the true context window size from the last iteration
- Understand token accumulation across server-side tool use loops
class BetaMessageIterationUsage:Token usage for a sampling iteration.
Token usage for a sampling iteration.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a sampling iteration
class BetaCompactionIterationUsage:Token usage for a compaction iteration.
Token usage for a compaction iteration.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a compaction iteration
The number of output tokens which were used.
required BetaServerToolUsage? ServerToolUseThe number of server tool requests.
The number of server tool requests.
The number of web fetch tool requests.
The number of web search tool requests.
required ServiceTier? ServiceTierIf the request used the priority, standard, or batch tier.
If the request used the priority, standard, or batch tier.
required Speed? SpeedThe inference speed mode used for this request.
The inference speed mode used for this request.
class BetaMessageBatchErroredResult:
required BetaErrorResponse Error
required BetaError Error
class BetaInvalidRequestError:
class BetaAuthenticationError:
class BetaBillingError:
class BetaPermissionError:
class BetaNotFoundError:
class BetaRateLimitError:
class BetaGatewayTimeoutError:
class BetaApiError:
class BetaOverloadedError:
class BetaMessageBatchCanceledResult:
class BetaMessageBatchExpiredResult:
class BetaMessageBatchRequestCounts:
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.
class BetaMessageBatchResult: A class that can be one of several variants.union Processing result for this request.
Processing result for this request.
Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration.
class BetaMessageBatchSucceededResult:
required BetaMessage Message
required string IDUnique object identifier.
Unique object identifier.
The format and length of IDs may change over time.
required BetaContainer? ContainerInformation about the container used in the request (for the code execution tool)
Information about the container used in the request (for the code execution tool)
Identifier for the container used in this request
The time at which the container will expire.
required IReadOnlyList<BetaSkill>? SkillsSkills loaded in the container
Skills loaded 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
required IReadOnlyList<BetaContentBlock> ContentContent generated by the model.
Content generated by the model.
This is an array of content blocks, each of which has a type that determines its shape.
Example:
[{"type": "text", "text": "Hi, I'm Claude."}]
If the request input messages ended with an assistant turn, then the response content will continue directly from that last turn. You can use this to constrain the model's output.
For example, if the input messages were:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("}
]
Then the response content might be:
[{"type": "text", "text": "B)"}]
class BetaTextBlock:
required IReadOnlyList<BetaTextCitation>? CitationsCitations supporting the text block.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaThinkingBlock:
class BetaRedactedThinkingBlock:
class BetaToolUseBlock:
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaServerToolUseBlock:
required Name Name
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaWebSearchToolResultBlock:
required BetaWebSearchToolResultBlockContent Content
class BetaWebSearchToolResultError:
required BetaWebSearchToolResultErrorCode ErrorCode
IReadOnlyList<BetaWebSearchResultBlock>
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaWebFetchToolResultBlock:
required Content Content
class BetaWebFetchToolResultErrorBlock:
required BetaWebFetchToolResultErrorCode ErrorCode
class BetaWebFetchBlock:
required BetaDocumentBlock Content
required BetaCitationConfig? CitationsCitation configuration for the document
Citation configuration for the document
required Source Source
class BetaBase64PdfSource:
class BetaPlainTextSource:
The title of the document
ISO 8601 timestamp when the content was retrieved
Fetched content URL
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaCodeExecutionToolResultBlock:
required BetaCodeExecutionToolResultBlockContent ContentCode execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
class BetaCodeExecutionToolResultError:
required BetaCodeExecutionToolResultErrorCode ErrorCode
class BetaCodeExecutionResultBlock:
required IReadOnlyList<BetaCodeExecutionOutputBlock> Content
class BetaEncryptedCodeExecutionResultBlock:Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
required IReadOnlyList<BetaCodeExecutionOutputBlock> Content
class BetaBashCodeExecutionToolResultBlock:
required Content Content
class BetaBashCodeExecutionToolResultError:
required ErrorCode ErrorCode
class BetaBashCodeExecutionResultBlock:
required IReadOnlyList<BetaBashCodeExecutionOutputBlock> Content
class BetaTextEditorCodeExecutionToolResultBlock:
required Content Content
class BetaTextEditorCodeExecutionToolResultError:
required ErrorCode ErrorCode
class BetaTextEditorCodeExecutionViewResultBlock:
required FileType FileType
class BetaTextEditorCodeExecutionCreateResultBlock:
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
class BetaToolSearchToolResultBlock:
required Content Content
class BetaToolSearchToolResultError:
required ErrorCode ErrorCode
class BetaToolSearchToolSearchResultBlock:
required IReadOnlyList<BetaToolReferenceBlock> ToolReferences
class BetaMcpToolUseBlock:
The name of the MCP tool
The name of the MCP server
class BetaMcpToolResultBlock:
required Content Content
IReadOnlyList<BetaTextBlock>
required IReadOnlyList<BetaTextCitation>? CitationsCitations supporting the text block.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaContainerUploadBlock:Response model for a file uploaded to the container.
Response model for a file uploaded to the container.
class BetaCompactionBlock:A compaction block returned when autocompact is triggered.
A compaction block returned when autocompact is triggered.
When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops.
Summary of compacted content, or null if compaction failed
required BetaContextManagementResponse? ContextManagementContext management response.
Context management response.
Information about context management strategies applied during the request.
required IReadOnlyList<AppliedEdit> AppliedEditsList of context management edits that were applied.
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse:
Number of input tokens cleared by this edit.
Number of tool uses that were cleared.
The type of context management edit applied.
class BetaClearThinking20251015EditResponse:
Number of input tokens cleared by this edit.
Number of thinking turns that were cleared.
The type of context management edit applied.
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
JsonElement Role "assistant"constantConversational role of the generated message.
Conversational role of the generated message.
This will always be "assistant".
required BetaStopReason? StopReasonThe reason that we stopped.
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
required string? StopSequenceWhich custom stop sequence was generated, if any.
Which custom stop sequence was generated, if any.
This value will be a non-null string if one of your custom stop sequences was generated.
JsonElement Type "message"constantObject type.
Object type.
For Messages, this is always "message".
required BetaUsage UsageBilling and rate-limit usage.
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The geographic region where inference was performed for this request.
The number of input tokens which were used.
required IReadOnlyList<BetaIterationsUsageItems>? IterationsPer-iteration token usage breakdown.
Per-iteration token usage breakdown.
Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to:
- Determine which iterations exceeded long context thresholds (>=200k tokens)
- Calculate the true context window size from the last iteration
- Understand token accumulation across server-side tool use loops
class BetaMessageIterationUsage:Token usage for a sampling iteration.
Token usage for a sampling iteration.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a sampling iteration
class BetaCompactionIterationUsage:Token usage for a compaction iteration.
Token usage for a compaction iteration.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a compaction iteration
The number of output tokens which were used.
required BetaServerToolUsage? ServerToolUseThe number of server tool requests.
The number of server tool requests.
The number of web fetch tool requests.
The number of web search tool requests.
required ServiceTier? ServiceTierIf the request used the priority, standard, or batch tier.
If the request used the priority, standard, or batch tier.
required Speed? SpeedThe inference speed mode used for this request.
The inference speed mode used for this request.
class BetaMessageBatchErroredResult:
required BetaErrorResponse Error
required BetaError Error
class BetaInvalidRequestError:
class BetaAuthenticationError:
class BetaBillingError:
class BetaPermissionError:
class BetaNotFoundError:
class BetaRateLimitError:
class BetaGatewayTimeoutError:
class BetaApiError:
class BetaOverloadedError:
class BetaMessageBatchCanceledResult:
class BetaMessageBatchExpiredResult:
class BetaMessageBatchSucceededResult:
required BetaMessage Message
required string IDUnique object identifier.
Unique object identifier.
The format and length of IDs may change over time.
required BetaContainer? ContainerInformation about the container used in the request (for the code execution tool)
Information about the container used in the request (for the code execution tool)
Identifier for the container used in this request
The time at which the container will expire.
required IReadOnlyList<BetaSkill>? SkillsSkills loaded in the container
Skills loaded 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
required IReadOnlyList<BetaContentBlock> ContentContent generated by the model.
Content generated by the model.
This is an array of content blocks, each of which has a type that determines its shape.
Example:
[{"type": "text", "text": "Hi, I'm Claude."}]
If the request input messages ended with an assistant turn, then the response content will continue directly from that last turn. You can use this to constrain the model's output.
For example, if the input messages were:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("}
]
Then the response content might be:
[{"type": "text", "text": "B)"}]
class BetaTextBlock:
required IReadOnlyList<BetaTextCitation>? CitationsCitations supporting the text block.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaThinkingBlock:
class BetaRedactedThinkingBlock:
class BetaToolUseBlock:
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaServerToolUseBlock:
required Name Name
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaWebSearchToolResultBlock:
required BetaWebSearchToolResultBlockContent Content
class BetaWebSearchToolResultError:
required BetaWebSearchToolResultErrorCode ErrorCode
IReadOnlyList<BetaWebSearchResultBlock>
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaWebFetchToolResultBlock:
required Content Content
class BetaWebFetchToolResultErrorBlock:
required BetaWebFetchToolResultErrorCode ErrorCode
class BetaWebFetchBlock:
required BetaDocumentBlock Content
required BetaCitationConfig? CitationsCitation configuration for the document
Citation configuration for the document
required Source Source
class BetaBase64PdfSource:
class BetaPlainTextSource:
The title of the document
ISO 8601 timestamp when the content was retrieved
Fetched content URL
Caller CallerTool invocation directly from the model.
Tool invocation directly from the model.
class BetaDirectCaller:Tool invocation directly from the model.
Tool invocation directly from the model.
class BetaServerToolCaller:Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class BetaServerToolCaller20260120:
class BetaCodeExecutionToolResultBlock:
required BetaCodeExecutionToolResultBlockContent ContentCode execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
class BetaCodeExecutionToolResultError:
required BetaCodeExecutionToolResultErrorCode ErrorCode
class BetaCodeExecutionResultBlock:
required IReadOnlyList<BetaCodeExecutionOutputBlock> Content
class BetaEncryptedCodeExecutionResultBlock:Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
required IReadOnlyList<BetaCodeExecutionOutputBlock> Content
class BetaBashCodeExecutionToolResultBlock:
required Content Content
class BetaBashCodeExecutionToolResultError:
required ErrorCode ErrorCode
class BetaBashCodeExecutionResultBlock:
required IReadOnlyList<BetaBashCodeExecutionOutputBlock> Content
class BetaTextEditorCodeExecutionToolResultBlock:
required Content Content
class BetaTextEditorCodeExecutionToolResultError:
required ErrorCode ErrorCode
class BetaTextEditorCodeExecutionViewResultBlock:
required FileType FileType
class BetaTextEditorCodeExecutionCreateResultBlock:
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
class BetaToolSearchToolResultBlock:
required Content Content
class BetaToolSearchToolResultError:
required ErrorCode ErrorCode
class BetaToolSearchToolSearchResultBlock:
required IReadOnlyList<BetaToolReferenceBlock> ToolReferences
class BetaMcpToolUseBlock:
The name of the MCP tool
The name of the MCP server
class BetaMcpToolResultBlock:
required Content Content
IReadOnlyList<BetaTextBlock>
required IReadOnlyList<BetaTextCitation>? CitationsCitations supporting the text block.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
class BetaCitationPageLocation:
class BetaCitationContentBlockLocation:
class BetaCitationsWebSearchResultLocation:
class BetaCitationSearchResultLocation:
class BetaContainerUploadBlock:Response model for a file uploaded to the container.
Response model for a file uploaded to the container.
class BetaCompactionBlock:A compaction block returned when autocompact is triggered.
A compaction block returned when autocompact is triggered.
When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops.
Summary of compacted content, or null if compaction failed
required BetaContextManagementResponse? ContextManagementContext management response.
Context management response.
Information about context management strategies applied during the request.
required IReadOnlyList<AppliedEdit> AppliedEditsList of context management edits that were applied.
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse:
Number of input tokens cleared by this edit.
Number of tool uses that were cleared.
The type of context management edit applied.
class BetaClearThinking20251015EditResponse:
Number of input tokens cleared by this edit.
Number of thinking turns that were cleared.
The type of context management edit applied.
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
JsonElement Role "assistant"constantConversational role of the generated message.
Conversational role of the generated message.
This will always be "assistant".
required BetaStopReason? StopReasonThe reason that we stopped.
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
required string? StopSequenceWhich custom stop sequence was generated, if any.
Which custom stop sequence was generated, if any.
This value will be a non-null string if one of your custom stop sequences was generated.
JsonElement Type "message"constantObject type.
Object type.
For Messages, this is always "message".
required BetaUsage UsageBilling and rate-limit usage.
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The geographic region where inference was performed for this request.
The number of input tokens which were used.
required IReadOnlyList<BetaIterationsUsageItems>? IterationsPer-iteration token usage breakdown.
Per-iteration token usage breakdown.
Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to:
- Determine which iterations exceeded long context thresholds (>=200k tokens)
- Calculate the true context window size from the last iteration
- Understand token accumulation across server-side tool use loops
class BetaMessageIterationUsage:Token usage for a sampling iteration.
Token usage for a sampling iteration.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a sampling iteration
class BetaCompactionIterationUsage:Token usage for a compaction iteration.
Token usage for a compaction iteration.
required BetaCacheCreation? CacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The number of input tokens which were used.
The number of output tokens which were used.
Usage for a compaction iteration
The number of output tokens which were used.
required BetaServerToolUsage? ServerToolUseThe number of server tool requests.
The number of server tool requests.
The number of web fetch tool requests.
The number of web search tool requests.
required ServiceTier? ServiceTierIf the request used the priority, standard, or batch tier.
If the request used the priority, standard, or batch tier.
required Speed? SpeedThe inference speed mode used for this request.
The inference speed mode used for this request.
BetaFiles
Upload File
List Files
Download File
Get File Metadata
Delete File
ModelsExpand Collapse
class DeletedFile:
ID of the deleted file.
Type TypeDeleted object type.
Deleted object type.
For file deletion, this is always "file_deleted".
class FileMetadata:
required string IDUnique object identifier.
Unique object identifier.
The format and length of IDs may change over time.
RFC 3339 datetime string representing when the file was created.
Original filename of the uploaded file.
MIME type of the file.
Size of the file in bytes.
JsonElement Type "file"constantObject type.
Object type.
For files, this is always "file".
Whether the file can be downloaded.