Beta
ModelsExpand Collapse
class BetaApiError:
JsonValue; type "api_error"constant"api_error"constant
class BetaAuthenticationError:
JsonValue; type "authentication_error"constant"authentication_error"constant
class BetaBillingError:
JsonValue; type "billing_error"constant"billing_error"constant
class BetaError: A class that can be one of several variants.union
class BetaInvalidRequestError:
JsonValue; type "invalid_request_error"constant"invalid_request_error"constant
class BetaAuthenticationError:
JsonValue; type "authentication_error"constant"authentication_error"constant
class BetaBillingError:
JsonValue; type "billing_error"constant"billing_error"constant
class BetaPermissionError:
JsonValue; type "permission_error"constant"permission_error"constant
class BetaNotFoundError:
JsonValue; type "not_found_error"constant"not_found_error"constant
class BetaRateLimitError:
JsonValue; type "rate_limit_error"constant"rate_limit_error"constant
class BetaGatewayTimeoutError:
JsonValue; type "timeout_error"constant"timeout_error"constant
class BetaApiError:
JsonValue; type "api_error"constant"api_error"constant
class BetaOverloadedError:
JsonValue; type "overloaded_error"constant"overloaded_error"constant
class BetaErrorResponse:
BetaError error
class BetaInvalidRequestError:
JsonValue; type "invalid_request_error"constant"invalid_request_error"constant
class BetaAuthenticationError:
JsonValue; type "authentication_error"constant"authentication_error"constant
class BetaBillingError:
JsonValue; type "billing_error"constant"billing_error"constant
class BetaPermissionError:
JsonValue; type "permission_error"constant"permission_error"constant
class BetaNotFoundError:
JsonValue; type "not_found_error"constant"not_found_error"constant
class BetaRateLimitError:
JsonValue; type "rate_limit_error"constant"rate_limit_error"constant
class BetaGatewayTimeoutError:
JsonValue; type "timeout_error"constant"timeout_error"constant
class BetaApiError:
JsonValue; type "api_error"constant"api_error"constant
class BetaOverloadedError:
JsonValue; type "overloaded_error"constant"overloaded_error"constant
JsonValue; type "error"constant"error"constant
class BetaGatewayTimeoutError:
JsonValue; type "timeout_error"constant"timeout_error"constant
class BetaInvalidRequestError:
JsonValue; type "invalid_request_error"constant"invalid_request_error"constant
class BetaNotFoundError:
JsonValue; type "not_found_error"constant"not_found_error"constant
class BetaOverloadedError:
JsonValue; type "overloaded_error"constant"overloaded_error"constant
class BetaPermissionError:
JsonValue; type "permission_error"constant"permission_error"constant
class BetaRateLimitError:
JsonValue; type "rate_limit_error"constant"rate_limit_error"constant
BetaModels
List Models
Get a Model
ModelsExpand Collapse
class BetaModelInfo:
String id
Unique model identifier.
LocalDateTime createdAt
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.
String displayName
A human-readable name for the model.
JsonValue; type "model"constant"model"constant
Object type.
For Models, this is always "model".
BetaMessages
Create a Message
Count tokens in a Message
ModelsExpand Collapse
class BetaAllThinkingTurns:
JsonValue; type "all"constant"all"constant
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaBashCodeExecutionOutputBlock:
JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
class BetaBashCodeExecutionOutputBlockParam:
JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
class BetaBashCodeExecutionResultBlock:
List<BetaBashCodeExecutionOutputBlock> content
JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
class BetaBashCodeExecutionResultBlockParam:
List<BetaBashCodeExecutionOutputBlockParam> content
JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
class BetaBashCodeExecutionToolResultBlock:
Content content
class BetaBashCodeExecutionToolResultError:
ErrorCode errorCode
JsonValue; type "bash_code_execution_tool_result_error"constant"bash_code_execution_tool_result_error"constant
class BetaBashCodeExecutionResultBlock:
List<BetaBashCodeExecutionOutputBlock> content
JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
JsonValue; type "bash_code_execution_tool_result"constant"bash_code_execution_tool_result"constant
class BetaBashCodeExecutionToolResultBlockParam:
Content content
class BetaBashCodeExecutionToolResultErrorParam:
ErrorCode errorCode
JsonValue; type "bash_code_execution_tool_result_error"constant"bash_code_execution_tool_result_error"constant
class BetaBashCodeExecutionResultBlockParam:
List<BetaBashCodeExecutionOutputBlockParam> content
JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
JsonValue; type "bash_code_execution_tool_result"constant"bash_code_execution_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaBashCodeExecutionToolResultError:
ErrorCode errorCode
JsonValue; type "bash_code_execution_tool_result_error"constant"bash_code_execution_tool_result_error"constant
class BetaBashCodeExecutionToolResultErrorParam:
ErrorCode errorCode
JsonValue; type "bash_code_execution_tool_result_error"constant"bash_code_execution_tool_result_error"constant
class BetaCacheControlEphemeral:
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCacheCreation:
long ephemeral1hInputTokens
The number of input tokens used to create the 1 hour cache entry.
long ephemeral5mInputTokens
The number of input tokens used to create the 5 minute cache entry.
class BetaCitationCharLocation:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationConfig:
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationsConfigParam:
class BetaCitationsDelta:
Citation citation
class BetaCitationCharLocation:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "citations_delta"constant"citations_delta"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaClearThinking20251015Edit:
JsonValue; type "clear_thinking_20251015"constant"clear_thinking_20251015"constant
Optional<Keep> keep
Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed.
class BetaThinkingTurns:
JsonValue; type "thinking_turns"constant"thinking_turns"constant
class BetaAllThinkingTurns:
JsonValue; type "all"constant"all"constant
JsonValue;
class BetaClearThinking20251015EditResponse:
long clearedInputTokens
Number of input tokens cleared by this edit.
long clearedThinkingTurns
Number of thinking turns that were cleared.
JsonValue; type "clear_thinking_20251015"constant"clear_thinking_20251015"constant
The type of context management edit applied.
class BetaClearToolUses20250919Edit:
JsonValue; type "clear_tool_uses_20250919"constant"clear_tool_uses_20250919"constant
Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed.
JsonValue; type "input_tokens"constant"input_tokens"constant
Optional<ClearToolInputs> clearToolInputs
Whether to clear all tool inputs (bool) or specific tool inputs to clear (list)
Optional<List<String>> excludeTools
Tool names whose uses are preserved from clearing
Number of tool uses to retain in the conversation
JsonValue; type "tool_uses"constant"tool_uses"constant
Optional<Trigger> trigger
Condition that triggers the context management strategy
class BetaInputTokensTrigger:
JsonValue; type "input_tokens"constant"input_tokens"constant
class BetaToolUsesTrigger:
JsonValue; type "tool_uses"constant"tool_uses"constant
class BetaClearToolUses20250919EditResponse:
long clearedInputTokens
Number of input tokens cleared by this edit.
long clearedToolUses
Number of tool uses that were cleared.
JsonValue; type "clear_tool_uses_20250919"constant"clear_tool_uses_20250919"constant
The type of context management edit applied.
class BetaCodeExecutionOutputBlock:
JsonValue; type "code_execution_output"constant"code_execution_output"constant
class BetaCodeExecutionOutputBlockParam:
JsonValue; type "code_execution_output"constant"code_execution_output"constant
class BetaCodeExecutionResultBlock:
List<BetaCodeExecutionOutputBlock> content
JsonValue; type "code_execution_output"constant"code_execution_output"constant
JsonValue; type "code_execution_result"constant"code_execution_result"constant
class BetaCodeExecutionResultBlockParam:
List<BetaCodeExecutionOutputBlockParam> content
JsonValue; type "code_execution_output"constant"code_execution_output"constant
JsonValue; type "code_execution_result"constant"code_execution_result"constant
class BetaCodeExecutionTool20250522:
JsonValue; name "code_execution"constant"code_execution"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "code_execution_20250522"constant"code_execution_20250522"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaCodeExecutionTool20250825:
JsonValue; name "code_execution"constant"code_execution"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaCodeExecutionToolResultBlock:
class BetaCodeExecutionToolResultError:
BetaCodeExecutionToolResultErrorCode errorCode
JsonValue; type "code_execution_tool_result_error"constant"code_execution_tool_result_error"constant
class BetaCodeExecutionResultBlock:
List<BetaCodeExecutionOutputBlock> content
JsonValue; type "code_execution_output"constant"code_execution_output"constant
JsonValue; type "code_execution_result"constant"code_execution_result"constant
JsonValue; type "code_execution_tool_result"constant"code_execution_tool_result"constant
class BetaCodeExecutionToolResultBlockContent: A class that can be one of several variants.union
class BetaCodeExecutionToolResultError:
BetaCodeExecutionToolResultErrorCode errorCode
JsonValue; type "code_execution_tool_result_error"constant"code_execution_tool_result_error"constant
class BetaCodeExecutionResultBlock:
List<BetaCodeExecutionOutputBlock> content
JsonValue; type "code_execution_output"constant"code_execution_output"constant
JsonValue; type "code_execution_result"constant"code_execution_result"constant
class BetaCodeExecutionToolResultBlockParam:
class BetaCodeExecutionToolResultErrorParam:
BetaCodeExecutionToolResultErrorCode errorCode
JsonValue; type "code_execution_tool_result_error"constant"code_execution_tool_result_error"constant
class BetaCodeExecutionResultBlockParam:
List<BetaCodeExecutionOutputBlockParam> content
JsonValue; type "code_execution_output"constant"code_execution_output"constant
JsonValue; type "code_execution_result"constant"code_execution_result"constant
JsonValue; type "code_execution_tool_result"constant"code_execution_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCodeExecutionToolResultBlockParamContent: A class that can be one of several variants.union
class BetaCodeExecutionToolResultErrorParam:
BetaCodeExecutionToolResultErrorCode errorCode
JsonValue; type "code_execution_tool_result_error"constant"code_execution_tool_result_error"constant
class BetaCodeExecutionResultBlockParam:
List<BetaCodeExecutionOutputBlockParam> content
JsonValue; type "code_execution_output"constant"code_execution_output"constant
JsonValue; type "code_execution_result"constant"code_execution_result"constant
class BetaCodeExecutionToolResultError:
BetaCodeExecutionToolResultErrorCode errorCode
JsonValue; type "code_execution_tool_result_error"constant"code_execution_tool_result_error"constant
enum BetaCodeExecutionToolResultErrorCode:
class BetaCodeExecutionToolResultErrorParam:
BetaCodeExecutionToolResultErrorCode errorCode
JsonValue; type "code_execution_tool_result_error"constant"code_execution_tool_result_error"constant
class BetaContainer:
Information about the container used in the request (for the code execution tool)
String id
Identifier for the container used in this request
LocalDateTime expiresAt
The time at which the container will expire.
Skills loaded in the container
String skillId
Skill ID
Type type
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
String version
Skill version or 'latest' for most recent version
class BetaContainerParams:
Container parameters with skills to be loaded.
Optional<String> id
Container id
List of skills to load in the container
String skillId
Skill ID
Type type
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Optional<String> version
Skill version or 'latest' for most recent version
class BetaContainerUploadBlock:
Response model for a file uploaded to the container.
JsonValue; type "container_upload"constant"container_upload"constant
class BetaContainerUploadBlockParam:
A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory.
JsonValue; type "container_upload"constant"container_upload"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaContentBlock: A class that can be one of several variants.union
Response model for a file uploaded to the container.
class BetaTextBlock:
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "text"constant"text"constant
class BetaThinkingBlock:
JsonValue; type "thinking"constant"thinking"constant
class BetaRedactedThinkingBlock:
JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
class BetaToolUseBlock:
JsonValue; type "tool_use"constant"tool_use"constant
Optional<Caller> caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
class BetaServerToolUseBlock:
Caller caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
Name name
JsonValue; type "server_tool_use"constant"server_tool_use"constant
class BetaWebSearchToolResultBlock:
class BetaWebSearchToolResultError:
BetaWebSearchToolResultErrorCode errorCode
JsonValue; type "web_search_tool_result_error"constant"web_search_tool_result_error"constant
List<BetaWebSearchResultBlock>
JsonValue; type "web_search_result"constant"web_search_result"constant
JsonValue; type "web_search_tool_result"constant"web_search_tool_result"constant
class BetaWebFetchToolResultBlock:
Content content
class BetaWebFetchToolResultErrorBlock:
BetaWebFetchToolResultErrorCode errorCode
JsonValue; type "web_fetch_tool_result_error"constant"web_fetch_tool_result_error"constant
class BetaWebFetchBlock:
BetaDocumentBlock content
Citation configuration for the document
Source source
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
Optional<String> title
The title of the document
JsonValue; type "document"constant"document"constant
Optional<String> retrievedAt
ISO 8601 timestamp when the content was retrieved
JsonValue; type "web_fetch_result"constant"web_fetch_result"constant
String url
Fetched content URL
JsonValue; type "web_fetch_tool_result"constant"web_fetch_tool_result"constant
class BetaCodeExecutionToolResultBlock:
class BetaCodeExecutionToolResultError:
BetaCodeExecutionToolResultErrorCode errorCode
JsonValue; type "code_execution_tool_result_error"constant"code_execution_tool_result_error"constant
class BetaCodeExecutionResultBlock:
List<BetaCodeExecutionOutputBlock> content
JsonValue; type "code_execution_output"constant"code_execution_output"constant
JsonValue; type "code_execution_result"constant"code_execution_result"constant
JsonValue; type "code_execution_tool_result"constant"code_execution_tool_result"constant
class BetaBashCodeExecutionToolResultBlock:
Content content
class BetaBashCodeExecutionToolResultError:
ErrorCode errorCode
JsonValue; type "bash_code_execution_tool_result_error"constant"bash_code_execution_tool_result_error"constant
class BetaBashCodeExecutionResultBlock:
List<BetaBashCodeExecutionOutputBlock> content
JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
JsonValue; type "bash_code_execution_tool_result"constant"bash_code_execution_tool_result"constant
class BetaTextEditorCodeExecutionToolResultBlock:
Content content
class BetaTextEditorCodeExecutionToolResultError:
ErrorCode errorCode
JsonValue; type "text_editor_code_execution_tool_result_error"constant"text_editor_code_execution_tool_result_error"constant
class BetaTextEditorCodeExecutionViewResultBlock:
FileType fileType
JsonValue; type "text_editor_code_execution_view_result"constant"text_editor_code_execution_view_result"constant
class BetaTextEditorCodeExecutionCreateResultBlock:
JsonValue; type "text_editor_code_execution_create_result"constant"text_editor_code_execution_create_result"constant
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
JsonValue; type "text_editor_code_execution_str_replace_result"constant"text_editor_code_execution_str_replace_result"constant
JsonValue; type "text_editor_code_execution_tool_result"constant"text_editor_code_execution_tool_result"constant
class BetaToolSearchToolResultBlock:
Content content
class BetaToolSearchToolResultError:
ErrorCode errorCode
JsonValue; type "tool_search_tool_result_error"constant"tool_search_tool_result_error"constant
class BetaToolSearchToolSearchResultBlock:
List<BetaToolReferenceBlock> toolReferences
JsonValue; type "tool_reference"constant"tool_reference"constant
JsonValue; type "tool_search_tool_search_result"constant"tool_search_tool_search_result"constant
JsonValue; type "tool_search_tool_result"constant"tool_search_tool_result"constant
class BetaMcpToolUseBlock:
String name
The name of the MCP tool
String serverName
The name of the MCP server
JsonValue; type "mcp_tool_use"constant"mcp_tool_use"constant
class BetaMcpToolResultBlock:
Content content
List<BetaTextBlock>
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "text"constant"text"constant
JsonValue; type "mcp_tool_result"constant"mcp_tool_result"constant
class BetaContainerUploadBlock:
Response model for a file uploaded to the container.
JsonValue; type "container_upload"constant"container_upload"constant
class BetaContentBlockParam: A class that can be one of several variants.union
Regular text content.
class BetaTextBlockParam:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaRequestDocumentBlock:
Source source
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
class BetaContentBlockSource:
Content content
class BetaTextBlockParam:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "content"constant"content"constant
class BetaUrlPdfSource:
JsonValue; type "url"constant"url"constant
class BetaFileDocumentSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "document"constant"document"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaSearchResultBlockParam:
List<BetaTextBlockParam> content
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "search_result"constant"search_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaThinkingBlockParam:
JsonValue; type "thinking"constant"thinking"constant
class BetaRedactedThinkingBlockParam:
JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
class BetaToolUseBlockParam:
JsonValue; type "tool_use"constant"tool_use"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Caller> caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
class BetaToolResultBlockParam:
JsonValue; type "tool_result"constant"tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Content> content
List<Block>
class BetaTextBlockParam:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaSearchResultBlockParam:
List<BetaTextBlockParam> content
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "search_result"constant"search_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaRequestDocumentBlock:
Source source
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
class BetaContentBlockSource:
Content content
class BetaTextBlockParam:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "content"constant"content"constant
class BetaUrlPdfSource:
JsonValue; type "url"constant"url"constant
class BetaFileDocumentSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "document"constant"document"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaToolReferenceBlockParam:
Tool reference block that can be included in tool_result content.
JsonValue; type "tool_reference"constant"tool_reference"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaServerToolUseBlockParam:
Name name
JsonValue; type "server_tool_use"constant"server_tool_use"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Caller> caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
class BetaWebSearchToolResultBlockParam:
JsonValue; type "web_search_result"constant"web_search_result"constant
class BetaWebSearchToolRequestError:
BetaWebSearchToolResultErrorCode errorCode
JsonValue; type "web_search_tool_result_error"constant"web_search_tool_result_error"constant
JsonValue; type "web_search_tool_result"constant"web_search_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaWebFetchToolResultBlockParam:
Content content
class BetaWebFetchToolResultErrorBlockParam:
BetaWebFetchToolResultErrorCode errorCode
JsonValue; type "web_fetch_tool_result_error"constant"web_fetch_tool_result_error"constant
class BetaWebFetchBlockParam:
BetaRequestDocumentBlock content
Source source
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
class BetaContentBlockSource:
Content content
class BetaTextBlockParam:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "content"constant"content"constant
class BetaUrlPdfSource:
JsonValue; type "url"constant"url"constant
class BetaFileDocumentSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "document"constant"document"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "web_fetch_result"constant"web_fetch_result"constant
String url
Fetched content URL
Optional<String> retrievedAt
ISO 8601 timestamp when the content was retrieved
JsonValue; type "web_fetch_tool_result"constant"web_fetch_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCodeExecutionToolResultBlockParam:
class BetaCodeExecutionToolResultErrorParam:
BetaCodeExecutionToolResultErrorCode errorCode
JsonValue; type "code_execution_tool_result_error"constant"code_execution_tool_result_error"constant
class BetaCodeExecutionResultBlockParam:
List<BetaCodeExecutionOutputBlockParam> content
JsonValue; type "code_execution_output"constant"code_execution_output"constant
JsonValue; type "code_execution_result"constant"code_execution_result"constant
JsonValue; type "code_execution_tool_result"constant"code_execution_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaBashCodeExecutionToolResultBlockParam:
Content content
class BetaBashCodeExecutionToolResultErrorParam:
ErrorCode errorCode
JsonValue; type "bash_code_execution_tool_result_error"constant"bash_code_execution_tool_result_error"constant
class BetaBashCodeExecutionResultBlockParam:
List<BetaBashCodeExecutionOutputBlockParam> content
JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
JsonValue; type "bash_code_execution_tool_result"constant"bash_code_execution_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaTextEditorCodeExecutionToolResultBlockParam:
Content content
class BetaTextEditorCodeExecutionToolResultErrorParam:
ErrorCode errorCode
JsonValue; type "text_editor_code_execution_tool_result_error"constant"text_editor_code_execution_tool_result_error"constant
class BetaTextEditorCodeExecutionViewResultBlockParam:
FileType fileType
JsonValue; type "text_editor_code_execution_view_result"constant"text_editor_code_execution_view_result"constant
class BetaTextEditorCodeExecutionCreateResultBlockParam:
JsonValue; type "text_editor_code_execution_create_result"constant"text_editor_code_execution_create_result"constant
class BetaTextEditorCodeExecutionStrReplaceResultBlockParam:
JsonValue; type "text_editor_code_execution_str_replace_result"constant"text_editor_code_execution_str_replace_result"constant
JsonValue; type "text_editor_code_execution_tool_result"constant"text_editor_code_execution_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaToolSearchToolResultBlockParam:
Content content
class BetaToolSearchToolResultErrorParam:
ErrorCode errorCode
JsonValue; type "tool_search_tool_result_error"constant"tool_search_tool_result_error"constant
class BetaToolSearchToolSearchResultBlockParam:
List<BetaToolReferenceBlockParam> toolReferences
JsonValue; type "tool_reference"constant"tool_reference"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "tool_search_tool_search_result"constant"tool_search_tool_search_result"constant
JsonValue; type "tool_search_tool_result"constant"tool_search_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaMcpToolUseBlockParam:
String serverName
The name of the MCP server
JsonValue; type "mcp_tool_use"constant"mcp_tool_use"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaRequestMcpToolResultBlockParam:
JsonValue; type "mcp_tool_result"constant"mcp_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Content> content
List<BetaTextBlockParam>
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaContainerUploadBlockParam:
A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory.
JsonValue; type "container_upload"constant"container_upload"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaContentBlockSource:
Content content
class BetaTextBlockParam:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "content"constant"content"constant
class BetaContentBlockSourceContent: A class that can be one of several variants.union
class BetaTextBlockParam:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaContextManagementConfig:
Optional<List<Edit>> edits
List of context management edits to apply
class BetaClearToolUses20250919Edit:
JsonValue; type "clear_tool_uses_20250919"constant"clear_tool_uses_20250919"constant
Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed.
JsonValue; type "input_tokens"constant"input_tokens"constant
Optional<ClearToolInputs> clearToolInputs
Whether to clear all tool inputs (bool) or specific tool inputs to clear (list)
Optional<List<String>> excludeTools
Tool names whose uses are preserved from clearing
Number of tool uses to retain in the conversation
JsonValue; type "tool_uses"constant"tool_uses"constant
Optional<Trigger> trigger
Condition that triggers the context management strategy
class BetaInputTokensTrigger:
JsonValue; type "input_tokens"constant"input_tokens"constant
class BetaToolUsesTrigger:
JsonValue; type "tool_uses"constant"tool_uses"constant
class BetaClearThinking20251015Edit:
JsonValue; type "clear_thinking_20251015"constant"clear_thinking_20251015"constant
Optional<Keep> keep
Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed.
class BetaThinkingTurns:
JsonValue; type "thinking_turns"constant"thinking_turns"constant
class BetaAllThinkingTurns:
JsonValue; type "all"constant"all"constant
JsonValue;
class BetaContextManagementResponse:
List<AppliedEdit> appliedEdits
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse:
long clearedInputTokens
Number of input tokens cleared by this edit.
long clearedToolUses
Number of tool uses that were cleared.
JsonValue; type "clear_tool_uses_20250919"constant"clear_tool_uses_20250919"constant
The type of context management edit applied.
class BetaClearThinking20251015EditResponse:
long clearedInputTokens
Number of input tokens cleared by this edit.
long clearedThinkingTurns
Number of thinking turns that were cleared.
JsonValue; type "clear_thinking_20251015"constant"clear_thinking_20251015"constant
The type of context management edit applied.
class BetaCountTokensContextManagementResponse:
long originalInputTokens
The original token count before context management was applied
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaDocumentBlock:
Citation configuration for the document
Source source
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
Optional<String> title
The title of the document
JsonValue; type "document"constant"document"constant
class BetaFileDocumentSource:
JsonValue; type "file"constant"file"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaInputJsonDelta:
JsonValue; type "input_json_delta"constant"input_json_delta"constant
class BetaInputTokensClearAtLeast:
JsonValue; type "input_tokens"constant"input_tokens"constant
class BetaInputTokensTrigger:
JsonValue; type "input_tokens"constant"input_tokens"constant
class BetaJsonOutputFormat:
Schema schema
The JSON schema of the format
JsonValue; type "json_schema"constant"json_schema"constant
class BetaMcpToolConfig:
Configuration for a specific tool in an MCP toolset.
class BetaMcpToolDefaultConfig:
Default configuration for tools in an MCP toolset.
class BetaMcpToolResultBlock:
Content content
List<BetaTextBlock>
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "text"constant"text"constant
JsonValue; type "mcp_tool_result"constant"mcp_tool_result"constant
class BetaMcpToolUseBlock:
String name
The name of the MCP tool
String serverName
The name of the MCP server
JsonValue; type "mcp_tool_use"constant"mcp_tool_use"constant
class BetaMcpToolUseBlockParam:
String serverName
The name of the MCP server
JsonValue; type "mcp_tool_use"constant"mcp_tool_use"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaMcpToolset:
Configuration for a group of tools from an MCP server.
Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides.
String mcpServerName
Name of the MCP server to configure tools for
JsonValue; type "mcp_toolset"constant"mcp_toolset"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Configs> configs
Configuration overrides for specific tools, keyed by tool name
Default configuration applied to all tools from this server
class BetaMemoryTool20250818:
JsonValue; name "memory"constant"memory"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "memory_20250818"constant"memory_20250818"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaMemoryTool20250818Command: A class that can be one of several variants.union
class BetaMemoryTool20250818ViewCommand:
JsonValue; command "view"constant"view"constant
Command type identifier
String path
Path to directory or file to view
Optional<List<Long>> viewRange
Optional line range for viewing specific lines
class BetaMemoryTool20250818CreateCommand:
JsonValue; command "create"constant"create"constant
Command type identifier
String fileText
Content to write to the file
String path
Path where the file should be created
class BetaMemoryTool20250818StrReplaceCommand:
JsonValue; command "str_replace"constant"str_replace"constant
Command type identifier
String newStr
Text to replace with
String oldStr
Text to search for and replace
String path
Path to the file where text should be replaced
class BetaMemoryTool20250818InsertCommand:
JsonValue; command "insert"constant"insert"constant
Command type identifier
long insertLine
Line number where text should be inserted
String insertText
Text to insert at the specified line
String path
Path to the file where text should be inserted
class BetaMemoryTool20250818DeleteCommand:
JsonValue; command "delete"constant"delete"constant
Command type identifier
String path
Path to the file or directory to delete
class BetaMemoryTool20250818RenameCommand:
JsonValue; command "rename"constant"rename"constant
Command type identifier
String newPath
New path for the file or directory
String oldPath
Current path of the file or directory
class BetaMemoryTool20250818CreateCommand:
JsonValue; command "create"constant"create"constant
Command type identifier
String fileText
Content to write to the file
String path
Path where the file should be created
class BetaMemoryTool20250818DeleteCommand:
JsonValue; command "delete"constant"delete"constant
Command type identifier
String path
Path to the file or directory to delete
class BetaMemoryTool20250818InsertCommand:
JsonValue; command "insert"constant"insert"constant
Command type identifier
long insertLine
Line number where text should be inserted
String insertText
Text to insert at the specified line
String path
Path to the file where text should be inserted
class BetaMemoryTool20250818RenameCommand:
JsonValue; command "rename"constant"rename"constant
Command type identifier
String newPath
New path for the file or directory
String oldPath
Current path of the file or directory
class BetaMemoryTool20250818StrReplaceCommand:
JsonValue; command "str_replace"constant"str_replace"constant
Command type identifier
String newStr
Text to replace with
String oldStr
Text to search for and replace
String path
Path to the file where text should be replaced
class BetaMemoryTool20250818ViewCommand:
JsonValue; command "view"constant"view"constant
Command type identifier
String path
Path to directory or file to view
Optional<List<Long>> viewRange
Optional line range for viewing specific lines
class BetaMessage:
String id
Unique object identifier.
The format and length of IDs may change over time.
Information about the container used in the request (for the code execution tool)
String id
Identifier for the container used in this request
LocalDateTime expiresAt
The time at which the container will expire.
Skills loaded in the container
String skillId
Skill ID
Type type
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
String version
Skill version or 'latest' for most recent version
List<BetaContentBlock> content
Content generated by the model.
This is an array of content blocks, each of which has a type that determines its shape.
Example:
[{"type": "text", "text": "Hi, I'm Claude."}]
If the request input messages ended with an assistant turn, then the response content will continue directly from that last turn. You can use this to constrain the model's output.
For example, if the input messages were:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("}
]
Then the response content might be:
[{"type": "text", "text": "B)"}]
class BetaTextBlock:
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "text"constant"text"constant
class BetaThinkingBlock:
JsonValue; type "thinking"constant"thinking"constant
class BetaRedactedThinkingBlock:
JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
class BetaToolUseBlock:
JsonValue; type "tool_use"constant"tool_use"constant
Optional<Caller> caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
class BetaServerToolUseBlock:
Caller caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
Name name
JsonValue; type "server_tool_use"constant"server_tool_use"constant
class BetaWebSearchToolResultBlock:
class BetaWebSearchToolResultError:
BetaWebSearchToolResultErrorCode errorCode
JsonValue; type "web_search_tool_result_error"constant"web_search_tool_result_error"constant
List<BetaWebSearchResultBlock>
JsonValue; type "web_search_result"constant"web_search_result"constant
JsonValue; type "web_search_tool_result"constant"web_search_tool_result"constant
class BetaWebFetchToolResultBlock:
Content content
class BetaWebFetchToolResultErrorBlock:
BetaWebFetchToolResultErrorCode errorCode
JsonValue; type "web_fetch_tool_result_error"constant"web_fetch_tool_result_error"constant
class BetaWebFetchBlock:
BetaDocumentBlock content
Citation configuration for the document
Source source
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
Optional<String> title
The title of the document
JsonValue; type "document"constant"document"constant
Optional<String> retrievedAt
ISO 8601 timestamp when the content was retrieved
JsonValue; type "web_fetch_result"constant"web_fetch_result"constant
String url
Fetched content URL
JsonValue; type "web_fetch_tool_result"constant"web_fetch_tool_result"constant
class BetaCodeExecutionToolResultBlock:
class BetaCodeExecutionToolResultError:
BetaCodeExecutionToolResultErrorCode errorCode
JsonValue; type "code_execution_tool_result_error"constant"code_execution_tool_result_error"constant
class BetaCodeExecutionResultBlock:
List<BetaCodeExecutionOutputBlock> content
JsonValue; type "code_execution_output"constant"code_execution_output"constant
JsonValue; type "code_execution_result"constant"code_execution_result"constant
JsonValue; type "code_execution_tool_result"constant"code_execution_tool_result"constant
class BetaBashCodeExecutionToolResultBlock:
Content content
class BetaBashCodeExecutionToolResultError:
ErrorCode errorCode
JsonValue; type "bash_code_execution_tool_result_error"constant"bash_code_execution_tool_result_error"constant
class BetaBashCodeExecutionResultBlock:
List<BetaBashCodeExecutionOutputBlock> content
JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
JsonValue; type "bash_code_execution_tool_result"constant"bash_code_execution_tool_result"constant
class BetaTextEditorCodeExecutionToolResultBlock:
Content content
class BetaTextEditorCodeExecutionToolResultError:
ErrorCode errorCode
JsonValue; type "text_editor_code_execution_tool_result_error"constant"text_editor_code_execution_tool_result_error"constant
class BetaTextEditorCodeExecutionViewResultBlock:
FileType fileType
JsonValue; type "text_editor_code_execution_view_result"constant"text_editor_code_execution_view_result"constant
class BetaTextEditorCodeExecutionCreateResultBlock:
JsonValue; type "text_editor_code_execution_create_result"constant"text_editor_code_execution_create_result"constant
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
JsonValue; type "text_editor_code_execution_str_replace_result"constant"text_editor_code_execution_str_replace_result"constant
JsonValue; type "text_editor_code_execution_tool_result"constant"text_editor_code_execution_tool_result"constant
class BetaToolSearchToolResultBlock:
Content content
class BetaToolSearchToolResultError:
ErrorCode errorCode
JsonValue; type "tool_search_tool_result_error"constant"tool_search_tool_result_error"constant
class BetaToolSearchToolSearchResultBlock:
List<BetaToolReferenceBlock> toolReferences
JsonValue; type "tool_reference"constant"tool_reference"constant
JsonValue; type "tool_search_tool_search_result"constant"tool_search_tool_search_result"constant
JsonValue; type "tool_search_tool_result"constant"tool_search_tool_result"constant
class BetaMcpToolUseBlock:
String name
The name of the MCP tool
String serverName
The name of the MCP server
JsonValue; type "mcp_tool_use"constant"mcp_tool_use"constant
class BetaMcpToolResultBlock:
Content content
List<BetaTextBlock>
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "text"constant"text"constant
JsonValue; type "mcp_tool_result"constant"mcp_tool_result"constant
class BetaContainerUploadBlock:
Response model for a file uploaded to the container.
JsonValue; type "container_upload"constant"container_upload"constant
Context management response.
Information about context management strategies applied during the request.
List<AppliedEdit> appliedEdits
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse:
long clearedInputTokens
Number of input tokens cleared by this edit.
long clearedToolUses
Number of tool uses that were cleared.
JsonValue; type "clear_tool_uses_20250919"constant"clear_tool_uses_20250919"constant
The type of context management edit applied.
class BetaClearThinking20251015EditResponse:
long clearedInputTokens
Number of input tokens cleared by this edit.
long clearedThinkingTurns
Number of thinking turns that were cleared.
JsonValue; type "clear_thinking_20251015"constant"clear_thinking_20251015"constant
The type of context management edit applied.
Model model
The model that will complete your prompt.
See models for additional details and options.
CLAUDE_OPUS_4_5_20251101("claude-opus-4-5-20251101")
Premium model combining maximum intelligence with practical performance
CLAUDE_OPUS_4_5("claude-opus-4-5")
Premium model combining maximum intelligence with practical performance
CLAUDE_3_7_SONNET_LATEST("claude-3-7-sonnet-latest")
High-performance model with early extended thinking
CLAUDE_3_7_SONNET_20250219("claude-3-7-sonnet-20250219")
High-performance model with early extended thinking
CLAUDE_3_5_HAIKU_LATEST("claude-3-5-haiku-latest")
Fastest and most compact model for near-instant responsiveness
CLAUDE_3_5_HAIKU_20241022("claude-3-5-haiku-20241022")
Our fastest model
CLAUDE_HAIKU_4_5("claude-haiku-4-5")
Hybrid model, capable of near-instant responses and extended thinking
CLAUDE_HAIKU_4_5_20251001("claude-haiku-4-5-20251001")
Hybrid model, capable of near-instant responses and extended thinking
CLAUDE_SONNET_4_20250514("claude-sonnet-4-20250514")
High-performance model with extended thinking
CLAUDE_SONNET_4_0("claude-sonnet-4-0")
High-performance model with extended thinking
CLAUDE_4_SONNET_20250514("claude-4-sonnet-20250514")
High-performance model with extended thinking
CLAUDE_SONNET_4_5("claude-sonnet-4-5")
Our best model for real-world agents and coding
CLAUDE_SONNET_4_5_20250929("claude-sonnet-4-5-20250929")
Our best model for real-world agents and coding
CLAUDE_OPUS_4_0("claude-opus-4-0")
Our most capable model
CLAUDE_OPUS_4_20250514("claude-opus-4-20250514")
Our most capable model
CLAUDE_4_OPUS_20250514("claude-4-opus-20250514")
Our most capable model
CLAUDE_OPUS_4_1_20250805("claude-opus-4-1-20250805")
Our most capable model
CLAUDE_3_OPUS_LATEST("claude-3-opus-latest")
Excels at writing and complex tasks
CLAUDE_3_OPUS_20240229("claude-3-opus-20240229")
Excels at writing and complex tasks
CLAUDE_3_HAIKU_20240307("claude-3-haiku-20240307")
Our previous most fast and cost-effective
JsonValue; role "assistant"constant"assistant"constant
Conversational role of the generated message.
This will always be "assistant".
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
Optional<String> stopSequence
Which custom stop sequence was generated, if any.
This value will be a non-null string if one of your custom stop sequences was generated.
JsonValue; type "message"constant"message"constant
Object type.
For Messages, this is always "message".
BetaUsage 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.
Breakdown of cached tokens by TTL
long ephemeral1hInputTokens
The number of input tokens used to create the 1 hour cache entry.
long ephemeral5mInputTokens
The number of input tokens used to create the 5 minute cache entry.
Optional<Long> cacheCreationInputTokens
The number of input tokens used to create the cache entry.
Optional<Long> cacheReadInputTokens
The number of input tokens read from the cache.
long inputTokens
The number of input tokens which were used.
long outputTokens
The number of output tokens which were used.
The number of server tool requests.
long webFetchRequests
The number of web fetch tool requests.
long webSearchRequests
The number of web search tool requests.
Optional<ServiceTier> serviceTier
If the request used the priority, standard, or batch tier.
class BetaMessageDeltaUsage:
Optional<Long> cacheCreationInputTokens
The cumulative number of input tokens used to create the cache entry.
Optional<Long> cacheReadInputTokens
The cumulative number of input tokens read from the cache.
Optional<Long> inputTokens
The cumulative number of input tokens which were used.
long outputTokens
The cumulative number of output tokens which were used.
The number of server tool requests.
long webFetchRequests
The number of web fetch tool requests.
long webSearchRequests
The number of web search tool requests.
class BetaMessageParam:
Content content
List<BetaContentBlockParam>
class BetaTextBlockParam:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaRequestDocumentBlock:
Source source
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
class BetaContentBlockSource:
Content content
class BetaTextBlockParam:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "content"constant"content"constant
class BetaUrlPdfSource:
JsonValue; type "url"constant"url"constant
class BetaFileDocumentSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "document"constant"document"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaSearchResultBlockParam:
List<BetaTextBlockParam> content
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "search_result"constant"search_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaThinkingBlockParam:
JsonValue; type "thinking"constant"thinking"constant
class BetaRedactedThinkingBlockParam:
JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
class BetaToolUseBlockParam:
JsonValue; type "tool_use"constant"tool_use"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Caller> caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
class BetaToolResultBlockParam:
JsonValue; type "tool_result"constant"tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Content> content
List<Block>
class BetaTextBlockParam:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaSearchResultBlockParam:
List<BetaTextBlockParam> content
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "search_result"constant"search_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaRequestDocumentBlock:
Source source
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
class BetaContentBlockSource:
Content content
class BetaTextBlockParam:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "content"constant"content"constant
class BetaUrlPdfSource:
JsonValue; type "url"constant"url"constant
class BetaFileDocumentSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "document"constant"document"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaToolReferenceBlockParam:
Tool reference block that can be included in tool_result content.
JsonValue; type "tool_reference"constant"tool_reference"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaServerToolUseBlockParam:
Name name
JsonValue; type "server_tool_use"constant"server_tool_use"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Caller> caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
class BetaWebSearchToolResultBlockParam:
JsonValue; type "web_search_result"constant"web_search_result"constant
class BetaWebSearchToolRequestError:
BetaWebSearchToolResultErrorCode errorCode
JsonValue; type "web_search_tool_result_error"constant"web_search_tool_result_error"constant
JsonValue; type "web_search_tool_result"constant"web_search_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaWebFetchToolResultBlockParam:
Content content
class BetaWebFetchToolResultErrorBlockParam:
BetaWebFetchToolResultErrorCode errorCode
JsonValue; type "web_fetch_tool_result_error"constant"web_fetch_tool_result_error"constant
class BetaWebFetchBlockParam:
BetaRequestDocumentBlock content
Source source
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
class BetaContentBlockSource:
Content content
class BetaTextBlockParam:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "content"constant"content"constant
class BetaUrlPdfSource:
JsonValue; type "url"constant"url"constant
class BetaFileDocumentSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "document"constant"document"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "web_fetch_result"constant"web_fetch_result"constant
String url
Fetched content URL
Optional<String> retrievedAt
ISO 8601 timestamp when the content was retrieved
JsonValue; type "web_fetch_tool_result"constant"web_fetch_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCodeExecutionToolResultBlockParam:
class BetaCodeExecutionToolResultErrorParam:
BetaCodeExecutionToolResultErrorCode errorCode
JsonValue; type "code_execution_tool_result_error"constant"code_execution_tool_result_error"constant
class BetaCodeExecutionResultBlockParam:
List<BetaCodeExecutionOutputBlockParam> content
JsonValue; type "code_execution_output"constant"code_execution_output"constant
JsonValue; type "code_execution_result"constant"code_execution_result"constant
JsonValue; type "code_execution_tool_result"constant"code_execution_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaBashCodeExecutionToolResultBlockParam:
Content content
class BetaBashCodeExecutionToolResultErrorParam:
ErrorCode errorCode
JsonValue; type "bash_code_execution_tool_result_error"constant"bash_code_execution_tool_result_error"constant
class BetaBashCodeExecutionResultBlockParam:
List<BetaBashCodeExecutionOutputBlockParam> content
JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
JsonValue; type "bash_code_execution_tool_result"constant"bash_code_execution_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaTextEditorCodeExecutionToolResultBlockParam:
Content content
class BetaTextEditorCodeExecutionToolResultErrorParam:
ErrorCode errorCode
JsonValue; type "text_editor_code_execution_tool_result_error"constant"text_editor_code_execution_tool_result_error"constant
class BetaTextEditorCodeExecutionViewResultBlockParam:
FileType fileType
JsonValue; type "text_editor_code_execution_view_result"constant"text_editor_code_execution_view_result"constant
class BetaTextEditorCodeExecutionCreateResultBlockParam:
JsonValue; type "text_editor_code_execution_create_result"constant"text_editor_code_execution_create_result"constant
class BetaTextEditorCodeExecutionStrReplaceResultBlockParam:
JsonValue; type "text_editor_code_execution_str_replace_result"constant"text_editor_code_execution_str_replace_result"constant
JsonValue; type "text_editor_code_execution_tool_result"constant"text_editor_code_execution_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaToolSearchToolResultBlockParam:
Content content
class BetaToolSearchToolResultErrorParam:
ErrorCode errorCode
JsonValue; type "tool_search_tool_result_error"constant"tool_search_tool_result_error"constant
class BetaToolSearchToolSearchResultBlockParam:
List<BetaToolReferenceBlockParam> toolReferences
JsonValue; type "tool_reference"constant"tool_reference"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "tool_search_tool_search_result"constant"tool_search_tool_search_result"constant
JsonValue; type "tool_search_tool_result"constant"tool_search_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaMcpToolUseBlockParam:
String serverName
The name of the MCP server
JsonValue; type "mcp_tool_use"constant"mcp_tool_use"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaRequestMcpToolResultBlockParam:
JsonValue; type "mcp_tool_result"constant"mcp_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Content> content
List<BetaTextBlockParam>
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaContainerUploadBlockParam:
A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory.
JsonValue; type "container_upload"constant"container_upload"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Role role
class BetaMessageTokensCount:
Information about context management applied to the message.
long originalInputTokens
The original token count before context management was applied
long inputTokens
The total number of tokens across the provided list of messages, system prompt, and tools.
class BetaMetadata:
Optional<String> userId
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:
Optional<Effort> effort
All possible effort levels.
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
class BetaRawContentBlockDelta: A class that can be one of several variants.union
class BetaTextDelta:
JsonValue; type "text_delta"constant"text_delta"constant
class BetaInputJsonDelta:
JsonValue; type "input_json_delta"constant"input_json_delta"constant
class BetaCitationsDelta:
Citation citation
class BetaCitationCharLocation:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "citations_delta"constant"citations_delta"constant
class BetaThinkingDelta:
JsonValue; type "thinking_delta"constant"thinking_delta"constant
class BetaSignatureDelta:
JsonValue; type "signature_delta"constant"signature_delta"constant
class BetaRawContentBlockDeltaEvent:
BetaRawContentBlockDelta delta
class BetaTextDelta:
JsonValue; type "text_delta"constant"text_delta"constant
class BetaInputJsonDelta:
JsonValue; type "input_json_delta"constant"input_json_delta"constant
class BetaCitationsDelta:
Citation citation
class BetaCitationCharLocation:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "citations_delta"constant"citations_delta"constant
class BetaThinkingDelta:
JsonValue; type "thinking_delta"constant"thinking_delta"constant
class BetaSignatureDelta:
JsonValue; type "signature_delta"constant"signature_delta"constant
JsonValue; type "content_block_delta"constant"content_block_delta"constant
class BetaRawContentBlockStartEvent:
ContentBlock contentBlock
Response model for a file uploaded to the container.
class BetaTextBlock:
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "text"constant"text"constant
class BetaThinkingBlock:
JsonValue; type "thinking"constant"thinking"constant
class BetaRedactedThinkingBlock:
JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
class BetaToolUseBlock:
JsonValue; type "tool_use"constant"tool_use"constant
Optional<Caller> caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
class BetaServerToolUseBlock:
Caller caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
Name name
JsonValue; type "server_tool_use"constant"server_tool_use"constant
class BetaWebSearchToolResultBlock:
class BetaWebSearchToolResultError:
BetaWebSearchToolResultErrorCode errorCode
JsonValue; type "web_search_tool_result_error"constant"web_search_tool_result_error"constant
List<BetaWebSearchResultBlock>
JsonValue; type "web_search_result"constant"web_search_result"constant
JsonValue; type "web_search_tool_result"constant"web_search_tool_result"constant
class BetaWebFetchToolResultBlock:
Content content
class BetaWebFetchToolResultErrorBlock:
BetaWebFetchToolResultErrorCode errorCode
JsonValue; type "web_fetch_tool_result_error"constant"web_fetch_tool_result_error"constant
class BetaWebFetchBlock:
BetaDocumentBlock content
Citation configuration for the document
Source source
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
Optional<String> title
The title of the document
JsonValue; type "document"constant"document"constant
Optional<String> retrievedAt
ISO 8601 timestamp when the content was retrieved
JsonValue; type "web_fetch_result"constant"web_fetch_result"constant
String url
Fetched content URL
JsonValue; type "web_fetch_tool_result"constant"web_fetch_tool_result"constant
class BetaCodeExecutionToolResultBlock:
class BetaCodeExecutionToolResultError:
BetaCodeExecutionToolResultErrorCode errorCode
JsonValue; type "code_execution_tool_result_error"constant"code_execution_tool_result_error"constant
class BetaCodeExecutionResultBlock:
List<BetaCodeExecutionOutputBlock> content
JsonValue; type "code_execution_output"constant"code_execution_output"constant
JsonValue; type "code_execution_result"constant"code_execution_result"constant
JsonValue; type "code_execution_tool_result"constant"code_execution_tool_result"constant
class BetaBashCodeExecutionToolResultBlock:
Content content
class BetaBashCodeExecutionToolResultError:
ErrorCode errorCode
JsonValue; type "bash_code_execution_tool_result_error"constant"bash_code_execution_tool_result_error"constant
class BetaBashCodeExecutionResultBlock:
List<BetaBashCodeExecutionOutputBlock> content
JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
JsonValue; type "bash_code_execution_tool_result"constant"bash_code_execution_tool_result"constant
class BetaTextEditorCodeExecutionToolResultBlock:
Content content
class BetaTextEditorCodeExecutionToolResultError:
ErrorCode errorCode
JsonValue; type "text_editor_code_execution_tool_result_error"constant"text_editor_code_execution_tool_result_error"constant
class BetaTextEditorCodeExecutionViewResultBlock:
FileType fileType
JsonValue; type "text_editor_code_execution_view_result"constant"text_editor_code_execution_view_result"constant
class BetaTextEditorCodeExecutionCreateResultBlock:
JsonValue; type "text_editor_code_execution_create_result"constant"text_editor_code_execution_create_result"constant
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
JsonValue; type "text_editor_code_execution_str_replace_result"constant"text_editor_code_execution_str_replace_result"constant
JsonValue; type "text_editor_code_execution_tool_result"constant"text_editor_code_execution_tool_result"constant
class BetaToolSearchToolResultBlock:
Content content
class BetaToolSearchToolResultError:
ErrorCode errorCode
JsonValue; type "tool_search_tool_result_error"constant"tool_search_tool_result_error"constant
class BetaToolSearchToolSearchResultBlock:
List<BetaToolReferenceBlock> toolReferences
JsonValue; type "tool_reference"constant"tool_reference"constant
JsonValue; type "tool_search_tool_search_result"constant"tool_search_tool_search_result"constant
JsonValue; type "tool_search_tool_result"constant"tool_search_tool_result"constant
class BetaMcpToolUseBlock:
String name
The name of the MCP tool
String serverName
The name of the MCP server
JsonValue; type "mcp_tool_use"constant"mcp_tool_use"constant
class BetaMcpToolResultBlock:
Content content
List<BetaTextBlock>
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "text"constant"text"constant
JsonValue; type "mcp_tool_result"constant"mcp_tool_result"constant
class BetaContainerUploadBlock:
Response model for a file uploaded to the container.
JsonValue; type "container_upload"constant"container_upload"constant
JsonValue; type "content_block_start"constant"content_block_start"constant
class BetaRawContentBlockStopEvent:
JsonValue; type "content_block_stop"constant"content_block_stop"constant
class BetaRawMessageDeltaEvent:
Information about context management strategies applied during the request
List<AppliedEdit> appliedEdits
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse:
long clearedInputTokens
Number of input tokens cleared by this edit.
long clearedToolUses
Number of tool uses that were cleared.
JsonValue; type "clear_tool_uses_20250919"constant"clear_tool_uses_20250919"constant
The type of context management edit applied.
class BetaClearThinking20251015EditResponse:
long clearedInputTokens
Number of input tokens cleared by this edit.
long clearedThinkingTurns
Number of thinking turns that were cleared.
JsonValue; type "clear_thinking_20251015"constant"clear_thinking_20251015"constant
The type of context management edit applied.
Delta delta
Information about the container used in the request (for the code execution tool)
String id
Identifier for the container used in this request
LocalDateTime expiresAt
The time at which the container will expire.
Skills loaded in the container
String skillId
Skill ID
Type type
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
String version
Skill version or 'latest' for most recent version
JsonValue; type "message_delta"constant"message_delta"constant
BetaMessageDeltaUsage 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.
Optional<Long> cacheCreationInputTokens
The cumulative number of input tokens used to create the cache entry.
Optional<Long> cacheReadInputTokens
The cumulative number of input tokens read from the cache.
Optional<Long> inputTokens
The cumulative number of input tokens which were used.
long outputTokens
The cumulative number of output tokens which were used.
The number of server tool requests.
long webFetchRequests
The number of web fetch tool requests.
long webSearchRequests
The number of web search tool requests.
class BetaRawMessageStartEvent:
BetaMessage message
String id
Unique object identifier.
The format and length of IDs may change over time.
Information about the container used in the request (for the code execution tool)
String id
Identifier for the container used in this request
LocalDateTime expiresAt
The time at which the container will expire.
Skills loaded in the container
String skillId
Skill ID
Type type
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
String version
Skill version or 'latest' for most recent version
List<BetaContentBlock> content
Content generated by the model.
This is an array of content blocks, each of which has a type that determines its shape.
Example:
[{"type": "text", "text": "Hi, I'm Claude."}]
If the request input messages ended with an assistant turn, then the response content will continue directly from that last turn. You can use this to constrain the model's output.
For example, if the input messages were:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("}
]
Then the response content might be:
[{"type": "text", "text": "B)"}]
class BetaTextBlock:
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "text"constant"text"constant
class BetaThinkingBlock:
JsonValue; type "thinking"constant"thinking"constant
class BetaRedactedThinkingBlock:
JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
class BetaToolUseBlock:
JsonValue; type "tool_use"constant"tool_use"constant
Optional<Caller> caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
class BetaServerToolUseBlock:
Caller caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
Name name
JsonValue; type "server_tool_use"constant"server_tool_use"constant
class BetaWebSearchToolResultBlock:
class BetaWebSearchToolResultError:
BetaWebSearchToolResultErrorCode errorCode
JsonValue; type "web_search_tool_result_error"constant"web_search_tool_result_error"constant
List<BetaWebSearchResultBlock>
JsonValue; type "web_search_result"constant"web_search_result"constant
JsonValue; type "web_search_tool_result"constant"web_search_tool_result"constant
class BetaWebFetchToolResultBlock:
Content content
class BetaWebFetchToolResultErrorBlock:
BetaWebFetchToolResultErrorCode errorCode
JsonValue; type "web_fetch_tool_result_error"constant"web_fetch_tool_result_error"constant
class BetaWebFetchBlock:
BetaDocumentBlock content
Citation configuration for the document
Source source
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
Optional<String> title
The title of the document
JsonValue; type "document"constant"document"constant
Optional<String> retrievedAt
ISO 8601 timestamp when the content was retrieved
JsonValue; type "web_fetch_result"constant"web_fetch_result"constant
String url
Fetched content URL
JsonValue; type "web_fetch_tool_result"constant"web_fetch_tool_result"constant
class BetaCodeExecutionToolResultBlock:
class BetaCodeExecutionToolResultError:
BetaCodeExecutionToolResultErrorCode errorCode
JsonValue; type "code_execution_tool_result_error"constant"code_execution_tool_result_error"constant
class BetaCodeExecutionResultBlock:
List<BetaCodeExecutionOutputBlock> content
JsonValue; type "code_execution_output"constant"code_execution_output"constant
JsonValue; type "code_execution_result"constant"code_execution_result"constant
JsonValue; type "code_execution_tool_result"constant"code_execution_tool_result"constant
class BetaBashCodeExecutionToolResultBlock:
Content content
class BetaBashCodeExecutionToolResultError:
ErrorCode errorCode
JsonValue; type "bash_code_execution_tool_result_error"constant"bash_code_execution_tool_result_error"constant
class BetaBashCodeExecutionResultBlock:
List<BetaBashCodeExecutionOutputBlock> content
JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
JsonValue; type "bash_code_execution_tool_result"constant"bash_code_execution_tool_result"constant
class BetaTextEditorCodeExecutionToolResultBlock:
Content content
class BetaTextEditorCodeExecutionToolResultError:
ErrorCode errorCode
JsonValue; type "text_editor_code_execution_tool_result_error"constant"text_editor_code_execution_tool_result_error"constant
class BetaTextEditorCodeExecutionViewResultBlock:
FileType fileType
JsonValue; type "text_editor_code_execution_view_result"constant"text_editor_code_execution_view_result"constant
class BetaTextEditorCodeExecutionCreateResultBlock:
JsonValue; type "text_editor_code_execution_create_result"constant"text_editor_code_execution_create_result"constant
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
JsonValue; type "text_editor_code_execution_str_replace_result"constant"text_editor_code_execution_str_replace_result"constant
JsonValue; type "text_editor_code_execution_tool_result"constant"text_editor_code_execution_tool_result"constant
class BetaToolSearchToolResultBlock:
Content content
class BetaToolSearchToolResultError:
ErrorCode errorCode
JsonValue; type "tool_search_tool_result_error"constant"tool_search_tool_result_error"constant
class BetaToolSearchToolSearchResultBlock:
List<BetaToolReferenceBlock> toolReferences
JsonValue; type "tool_reference"constant"tool_reference"constant
JsonValue; type "tool_search_tool_search_result"constant"tool_search_tool_search_result"constant
JsonValue; type "tool_search_tool_result"constant"tool_search_tool_result"constant
class BetaMcpToolUseBlock:
String name
The name of the MCP tool
String serverName
The name of the MCP server
JsonValue; type "mcp_tool_use"constant"mcp_tool_use"constant
class BetaMcpToolResultBlock:
Content content
List<BetaTextBlock>
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "text"constant"text"constant
JsonValue; type "mcp_tool_result"constant"mcp_tool_result"constant
class BetaContainerUploadBlock:
Response model for a file uploaded to the container.
JsonValue; type "container_upload"constant"container_upload"constant
Context management response.
Information about context management strategies applied during the request.
List<AppliedEdit> appliedEdits
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse:
long clearedInputTokens
Number of input tokens cleared by this edit.
long clearedToolUses
Number of tool uses that were cleared.
JsonValue; type "clear_tool_uses_20250919"constant"clear_tool_uses_20250919"constant
The type of context management edit applied.
class BetaClearThinking20251015EditResponse:
long clearedInputTokens
Number of input tokens cleared by this edit.
long clearedThinkingTurns
Number of thinking turns that were cleared.
JsonValue; type "clear_thinking_20251015"constant"clear_thinking_20251015"constant
The type of context management edit applied.
Model model
The model that will complete your prompt.
See models for additional details and options.
CLAUDE_OPUS_4_5_20251101("claude-opus-4-5-20251101")
Premium model combining maximum intelligence with practical performance
CLAUDE_OPUS_4_5("claude-opus-4-5")
Premium model combining maximum intelligence with practical performance
CLAUDE_3_7_SONNET_LATEST("claude-3-7-sonnet-latest")
High-performance model with early extended thinking
CLAUDE_3_7_SONNET_20250219("claude-3-7-sonnet-20250219")
High-performance model with early extended thinking
CLAUDE_3_5_HAIKU_LATEST("claude-3-5-haiku-latest")
Fastest and most compact model for near-instant responsiveness
CLAUDE_3_5_HAIKU_20241022("claude-3-5-haiku-20241022")
Our fastest model
CLAUDE_HAIKU_4_5("claude-haiku-4-5")
Hybrid model, capable of near-instant responses and extended thinking
CLAUDE_HAIKU_4_5_20251001("claude-haiku-4-5-20251001")
Hybrid model, capable of near-instant responses and extended thinking
CLAUDE_SONNET_4_20250514("claude-sonnet-4-20250514")
High-performance model with extended thinking
CLAUDE_SONNET_4_0("claude-sonnet-4-0")
High-performance model with extended thinking
CLAUDE_4_SONNET_20250514("claude-4-sonnet-20250514")
High-performance model with extended thinking
CLAUDE_SONNET_4_5("claude-sonnet-4-5")
Our best model for real-world agents and coding
CLAUDE_SONNET_4_5_20250929("claude-sonnet-4-5-20250929")
Our best model for real-world agents and coding
CLAUDE_OPUS_4_0("claude-opus-4-0")
Our most capable model
CLAUDE_OPUS_4_20250514("claude-opus-4-20250514")
Our most capable model
CLAUDE_4_OPUS_20250514("claude-4-opus-20250514")
Our most capable model
CLAUDE_OPUS_4_1_20250805("claude-opus-4-1-20250805")
Our most capable model
CLAUDE_3_OPUS_LATEST("claude-3-opus-latest")
Excels at writing and complex tasks
CLAUDE_3_OPUS_20240229("claude-3-opus-20240229")
Excels at writing and complex tasks
CLAUDE_3_HAIKU_20240307("claude-3-haiku-20240307")
Our previous most fast and cost-effective
JsonValue; role "assistant"constant"assistant"constant
Conversational role of the generated message.
This will always be "assistant".
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
Optional<String> stopSequence
Which custom stop sequence was generated, if any.
This value will be a non-null string if one of your custom stop sequences was generated.
JsonValue; type "message"constant"message"constant
Object type.
For Messages, this is always "message".
BetaUsage 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.
Breakdown of cached tokens by TTL
long ephemeral1hInputTokens
The number of input tokens used to create the 1 hour cache entry.
long ephemeral5mInputTokens
The number of input tokens used to create the 5 minute cache entry.
Optional<Long> cacheCreationInputTokens
The number of input tokens used to create the cache entry.
Optional<Long> cacheReadInputTokens
The number of input tokens read from the cache.
long inputTokens
The number of input tokens which were used.
long outputTokens
The number of output tokens which were used.
The number of server tool requests.
long webFetchRequests
The number of web fetch tool requests.
long webSearchRequests
The number of web search tool requests.
Optional<ServiceTier> serviceTier
If the request used the priority, standard, or batch tier.
JsonValue; type "message_start"constant"message_start"constant
class BetaRawMessageStopEvent:
JsonValue; type "message_stop"constant"message_stop"constant
class BetaRawMessageStreamEvent: A class that can be one of several variants.union
class BetaRawMessageStartEvent:
BetaMessage message
String id
Unique object identifier.
The format and length of IDs may change over time.
Information about the container used in the request (for the code execution tool)
String id
Identifier for the container used in this request
LocalDateTime expiresAt
The time at which the container will expire.
Skills loaded in the container
String skillId
Skill ID
Type type
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
String version
Skill version or 'latest' for most recent version
List<BetaContentBlock> content
Content generated by the model.
This is an array of content blocks, each of which has a type that determines its shape.
Example:
[{"type": "text", "text": "Hi, I'm Claude."}]
If the request input messages ended with an assistant turn, then the response content will continue directly from that last turn. You can use this to constrain the model's output.
For example, if the input messages were:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("}
]
Then the response content might be:
[{"type": "text", "text": "B)"}]
class BetaTextBlock:
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "text"constant"text"constant
class BetaThinkingBlock:
JsonValue; type "thinking"constant"thinking"constant
class BetaRedactedThinkingBlock:
JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
class BetaToolUseBlock:
JsonValue; type "tool_use"constant"tool_use"constant
Optional<Caller> caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
class BetaServerToolUseBlock:
Caller caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
Name name
JsonValue; type "server_tool_use"constant"server_tool_use"constant
class BetaWebSearchToolResultBlock:
class BetaWebSearchToolResultError:
BetaWebSearchToolResultErrorCode errorCode
JsonValue; type "web_search_tool_result_error"constant"web_search_tool_result_error"constant
List<BetaWebSearchResultBlock>
JsonValue; type "web_search_result"constant"web_search_result"constant
JsonValue; type "web_search_tool_result"constant"web_search_tool_result"constant
class BetaWebFetchToolResultBlock:
Content content
class BetaWebFetchToolResultErrorBlock:
BetaWebFetchToolResultErrorCode errorCode
JsonValue; type "web_fetch_tool_result_error"constant"web_fetch_tool_result_error"constant
class BetaWebFetchBlock:
BetaDocumentBlock content
Citation configuration for the document
Source source
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
Optional<String> title
The title of the document
JsonValue; type "document"constant"document"constant
Optional<String> retrievedAt
ISO 8601 timestamp when the content was retrieved
JsonValue; type "web_fetch_result"constant"web_fetch_result"constant
String url
Fetched content URL
JsonValue; type "web_fetch_tool_result"constant"web_fetch_tool_result"constant
class BetaCodeExecutionToolResultBlock:
class BetaCodeExecutionToolResultError:
BetaCodeExecutionToolResultErrorCode errorCode
JsonValue; type "code_execution_tool_result_error"constant"code_execution_tool_result_error"constant
class BetaCodeExecutionResultBlock:
List<BetaCodeExecutionOutputBlock> content
JsonValue; type "code_execution_output"constant"code_execution_output"constant
JsonValue; type "code_execution_result"constant"code_execution_result"constant
JsonValue; type "code_execution_tool_result"constant"code_execution_tool_result"constant
class BetaBashCodeExecutionToolResultBlock:
Content content
class BetaBashCodeExecutionToolResultError:
ErrorCode errorCode
JsonValue; type "bash_code_execution_tool_result_error"constant"bash_code_execution_tool_result_error"constant
class BetaBashCodeExecutionResultBlock:
List<BetaBashCodeExecutionOutputBlock> content
JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
JsonValue; type "bash_code_execution_tool_result"constant"bash_code_execution_tool_result"constant
class BetaTextEditorCodeExecutionToolResultBlock:
Content content
class BetaTextEditorCodeExecutionToolResultError:
ErrorCode errorCode
JsonValue; type "text_editor_code_execution_tool_result_error"constant"text_editor_code_execution_tool_result_error"constant
class BetaTextEditorCodeExecutionViewResultBlock:
FileType fileType
JsonValue; type "text_editor_code_execution_view_result"constant"text_editor_code_execution_view_result"constant
class BetaTextEditorCodeExecutionCreateResultBlock:
JsonValue; type "text_editor_code_execution_create_result"constant"text_editor_code_execution_create_result"constant
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
JsonValue; type "text_editor_code_execution_str_replace_result"constant"text_editor_code_execution_str_replace_result"constant
JsonValue; type "text_editor_code_execution_tool_result"constant"text_editor_code_execution_tool_result"constant
class BetaToolSearchToolResultBlock:
Content content
class BetaToolSearchToolResultError:
ErrorCode errorCode
JsonValue; type "tool_search_tool_result_error"constant"tool_search_tool_result_error"constant
class BetaToolSearchToolSearchResultBlock:
List<BetaToolReferenceBlock> toolReferences
JsonValue; type "tool_reference"constant"tool_reference"constant
JsonValue; type "tool_search_tool_search_result"constant"tool_search_tool_search_result"constant
JsonValue; type "tool_search_tool_result"constant"tool_search_tool_result"constant
class BetaMcpToolUseBlock:
String name
The name of the MCP tool
String serverName
The name of the MCP server
JsonValue; type "mcp_tool_use"constant"mcp_tool_use"constant
class BetaMcpToolResultBlock:
Content content
List<BetaTextBlock>
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "text"constant"text"constant
JsonValue; type "mcp_tool_result"constant"mcp_tool_result"constant
class BetaContainerUploadBlock:
Response model for a file uploaded to the container.
JsonValue; type "container_upload"constant"container_upload"constant
Context management response.
Information about context management strategies applied during the request.
List<AppliedEdit> appliedEdits
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse:
long clearedInputTokens
Number of input tokens cleared by this edit.
long clearedToolUses
Number of tool uses that were cleared.
JsonValue; type "clear_tool_uses_20250919"constant"clear_tool_uses_20250919"constant
The type of context management edit applied.
class BetaClearThinking20251015EditResponse:
long clearedInputTokens
Number of input tokens cleared by this edit.
long clearedThinkingTurns
Number of thinking turns that were cleared.
JsonValue; type "clear_thinking_20251015"constant"clear_thinking_20251015"constant
The type of context management edit applied.
Model model
The model that will complete your prompt.
See models for additional details and options.
CLAUDE_OPUS_4_5_20251101("claude-opus-4-5-20251101")
Premium model combining maximum intelligence with practical performance
CLAUDE_OPUS_4_5("claude-opus-4-5")
Premium model combining maximum intelligence with practical performance
CLAUDE_3_7_SONNET_LATEST("claude-3-7-sonnet-latest")
High-performance model with early extended thinking
CLAUDE_3_7_SONNET_20250219("claude-3-7-sonnet-20250219")
High-performance model with early extended thinking
CLAUDE_3_5_HAIKU_LATEST("claude-3-5-haiku-latest")
Fastest and most compact model for near-instant responsiveness
CLAUDE_3_5_HAIKU_20241022("claude-3-5-haiku-20241022")
Our fastest model
CLAUDE_HAIKU_4_5("claude-haiku-4-5")
Hybrid model, capable of near-instant responses and extended thinking
CLAUDE_HAIKU_4_5_20251001("claude-haiku-4-5-20251001")
Hybrid model, capable of near-instant responses and extended thinking
CLAUDE_SONNET_4_20250514("claude-sonnet-4-20250514")
High-performance model with extended thinking
CLAUDE_SONNET_4_0("claude-sonnet-4-0")
High-performance model with extended thinking
CLAUDE_4_SONNET_20250514("claude-4-sonnet-20250514")
High-performance model with extended thinking
CLAUDE_SONNET_4_5("claude-sonnet-4-5")
Our best model for real-world agents and coding
CLAUDE_SONNET_4_5_20250929("claude-sonnet-4-5-20250929")
Our best model for real-world agents and coding
CLAUDE_OPUS_4_0("claude-opus-4-0")
Our most capable model
CLAUDE_OPUS_4_20250514("claude-opus-4-20250514")
Our most capable model
CLAUDE_4_OPUS_20250514("claude-4-opus-20250514")
Our most capable model
CLAUDE_OPUS_4_1_20250805("claude-opus-4-1-20250805")
Our most capable model
CLAUDE_3_OPUS_LATEST("claude-3-opus-latest")
Excels at writing and complex tasks
CLAUDE_3_OPUS_20240229("claude-3-opus-20240229")
Excels at writing and complex tasks
CLAUDE_3_HAIKU_20240307("claude-3-haiku-20240307")
Our previous most fast and cost-effective
JsonValue; role "assistant"constant"assistant"constant
Conversational role of the generated message.
This will always be "assistant".
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
Optional<String> stopSequence
Which custom stop sequence was generated, if any.
This value will be a non-null string if one of your custom stop sequences was generated.
JsonValue; type "message"constant"message"constant
Object type.
For Messages, this is always "message".
BetaUsage 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.
Breakdown of cached tokens by TTL
long ephemeral1hInputTokens
The number of input tokens used to create the 1 hour cache entry.
long ephemeral5mInputTokens
The number of input tokens used to create the 5 minute cache entry.
Optional<Long> cacheCreationInputTokens
The number of input tokens used to create the cache entry.
Optional<Long> cacheReadInputTokens
The number of input tokens read from the cache.
long inputTokens
The number of input tokens which were used.
long outputTokens
The number of output tokens which were used.
The number of server tool requests.
long webFetchRequests
The number of web fetch tool requests.
long webSearchRequests
The number of web search tool requests.
Optional<ServiceTier> serviceTier
If the request used the priority, standard, or batch tier.
JsonValue; type "message_start"constant"message_start"constant
class BetaRawMessageDeltaEvent:
Information about context management strategies applied during the request
List<AppliedEdit> appliedEdits
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse:
long clearedInputTokens
Number of input tokens cleared by this edit.
long clearedToolUses
Number of tool uses that were cleared.
JsonValue; type "clear_tool_uses_20250919"constant"clear_tool_uses_20250919"constant
The type of context management edit applied.
class BetaClearThinking20251015EditResponse:
long clearedInputTokens
Number of input tokens cleared by this edit.
long clearedThinkingTurns
Number of thinking turns that were cleared.
JsonValue; type "clear_thinking_20251015"constant"clear_thinking_20251015"constant
The type of context management edit applied.
Delta delta
Information about the container used in the request (for the code execution tool)
String id
Identifier for the container used in this request
LocalDateTime expiresAt
The time at which the container will expire.
Skills loaded in the container
String skillId
Skill ID
Type type
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
String version
Skill version or 'latest' for most recent version
JsonValue; type "message_delta"constant"message_delta"constant
BetaMessageDeltaUsage 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.
Optional<Long> cacheCreationInputTokens
The cumulative number of input tokens used to create the cache entry.
Optional<Long> cacheReadInputTokens
The cumulative number of input tokens read from the cache.
Optional<Long> inputTokens
The cumulative number of input tokens which were used.
long outputTokens
The cumulative number of output tokens which were used.
The number of server tool requests.
long webFetchRequests
The number of web fetch tool requests.
long webSearchRequests
The number of web search tool requests.
class BetaRawMessageStopEvent:
JsonValue; type "message_stop"constant"message_stop"constant
class BetaRawContentBlockStartEvent:
ContentBlock contentBlock
Response model for a file uploaded to the container.
class BetaTextBlock:
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "text"constant"text"constant
class BetaThinkingBlock:
JsonValue; type "thinking"constant"thinking"constant
class BetaRedactedThinkingBlock:
JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
class BetaToolUseBlock:
JsonValue; type "tool_use"constant"tool_use"constant
Optional<Caller> caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
class BetaServerToolUseBlock:
Caller caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
Name name
JsonValue; type "server_tool_use"constant"server_tool_use"constant
class BetaWebSearchToolResultBlock:
class BetaWebSearchToolResultError:
BetaWebSearchToolResultErrorCode errorCode
JsonValue; type "web_search_tool_result_error"constant"web_search_tool_result_error"constant
List<BetaWebSearchResultBlock>
JsonValue; type "web_search_result"constant"web_search_result"constant
JsonValue; type "web_search_tool_result"constant"web_search_tool_result"constant
class BetaWebFetchToolResultBlock:
Content content
class BetaWebFetchToolResultErrorBlock:
BetaWebFetchToolResultErrorCode errorCode
JsonValue; type "web_fetch_tool_result_error"constant"web_fetch_tool_result_error"constant
class BetaWebFetchBlock:
BetaDocumentBlock content
Citation configuration for the document
Source source
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
Optional<String> title
The title of the document
JsonValue; type "document"constant"document"constant
Optional<String> retrievedAt
ISO 8601 timestamp when the content was retrieved
JsonValue; type "web_fetch_result"constant"web_fetch_result"constant
String url
Fetched content URL
JsonValue; type "web_fetch_tool_result"constant"web_fetch_tool_result"constant
class BetaCodeExecutionToolResultBlock:
class BetaCodeExecutionToolResultError:
BetaCodeExecutionToolResultErrorCode errorCode
JsonValue; type "code_execution_tool_result_error"constant"code_execution_tool_result_error"constant
class BetaCodeExecutionResultBlock:
List<BetaCodeExecutionOutputBlock> content
JsonValue; type "code_execution_output"constant"code_execution_output"constant
JsonValue; type "code_execution_result"constant"code_execution_result"constant
JsonValue; type "code_execution_tool_result"constant"code_execution_tool_result"constant
class BetaBashCodeExecutionToolResultBlock:
Content content
class BetaBashCodeExecutionToolResultError:
ErrorCode errorCode
JsonValue; type "bash_code_execution_tool_result_error"constant"bash_code_execution_tool_result_error"constant
class BetaBashCodeExecutionResultBlock:
List<BetaBashCodeExecutionOutputBlock> content
JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
JsonValue; type "bash_code_execution_tool_result"constant"bash_code_execution_tool_result"constant
class BetaTextEditorCodeExecutionToolResultBlock:
Content content
class BetaTextEditorCodeExecutionToolResultError:
ErrorCode errorCode
JsonValue; type "text_editor_code_execution_tool_result_error"constant"text_editor_code_execution_tool_result_error"constant
class BetaTextEditorCodeExecutionViewResultBlock:
FileType fileType
JsonValue; type "text_editor_code_execution_view_result"constant"text_editor_code_execution_view_result"constant
class BetaTextEditorCodeExecutionCreateResultBlock:
JsonValue; type "text_editor_code_execution_create_result"constant"text_editor_code_execution_create_result"constant
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
JsonValue; type "text_editor_code_execution_str_replace_result"constant"text_editor_code_execution_str_replace_result"constant
JsonValue; type "text_editor_code_execution_tool_result"constant"text_editor_code_execution_tool_result"constant
class BetaToolSearchToolResultBlock:
Content content
class BetaToolSearchToolResultError:
ErrorCode errorCode
JsonValue; type "tool_search_tool_result_error"constant"tool_search_tool_result_error"constant
class BetaToolSearchToolSearchResultBlock:
List<BetaToolReferenceBlock> toolReferences
JsonValue; type "tool_reference"constant"tool_reference"constant
JsonValue; type "tool_search_tool_search_result"constant"tool_search_tool_search_result"constant
JsonValue; type "tool_search_tool_result"constant"tool_search_tool_result"constant
class BetaMcpToolUseBlock:
String name
The name of the MCP tool
String serverName
The name of the MCP server
JsonValue; type "mcp_tool_use"constant"mcp_tool_use"constant
class BetaMcpToolResultBlock:
Content content
List<BetaTextBlock>
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "text"constant"text"constant
JsonValue; type "mcp_tool_result"constant"mcp_tool_result"constant
class BetaContainerUploadBlock:
Response model for a file uploaded to the container.
JsonValue; type "container_upload"constant"container_upload"constant
JsonValue; type "content_block_start"constant"content_block_start"constant
class BetaRawContentBlockDeltaEvent:
BetaRawContentBlockDelta delta
class BetaTextDelta:
JsonValue; type "text_delta"constant"text_delta"constant
class BetaInputJsonDelta:
JsonValue; type "input_json_delta"constant"input_json_delta"constant
class BetaCitationsDelta:
Citation citation
class BetaCitationCharLocation:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "citations_delta"constant"citations_delta"constant
class BetaThinkingDelta:
JsonValue; type "thinking_delta"constant"thinking_delta"constant
class BetaSignatureDelta:
JsonValue; type "signature_delta"constant"signature_delta"constant
JsonValue; type "content_block_delta"constant"content_block_delta"constant
class BetaRawContentBlockStopEvent:
JsonValue; type "content_block_stop"constant"content_block_stop"constant
class BetaRedactedThinkingBlock:
JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
class BetaRedactedThinkingBlockParam:
JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
class BetaRequestDocumentBlock:
Source source
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
class BetaContentBlockSource:
Content content
class BetaTextBlockParam:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "content"constant"content"constant
class BetaUrlPdfSource:
JsonValue; type "url"constant"url"constant
class BetaFileDocumentSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "document"constant"document"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaRequestMcpServerToolConfiguration:
class BetaRequestMcpServerUrlDefinition:
JsonValue; type "url"constant"url"constant
class BetaRequestMcpToolResultBlockParam:
JsonValue; type "mcp_tool_result"constant"mcp_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Content> content
List<BetaTextBlockParam>
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaSearchResultBlockParam:
List<BetaTextBlockParam> content
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "search_result"constant"search_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
class BetaServerToolUsage:
long webFetchRequests
The number of web fetch tool requests.
long webSearchRequests
The number of web search tool requests.
class BetaServerToolUseBlock:
Caller caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
Name name
JsonValue; type "server_tool_use"constant"server_tool_use"constant
class BetaServerToolUseBlockParam:
Name name
JsonValue; type "server_tool_use"constant"server_tool_use"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Caller> caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
class BetaSignatureDelta:
JsonValue; type "signature_delta"constant"signature_delta"constant
class BetaSkill:
A skill that was loaded in a container (response model).
String skillId
Skill ID
Type type
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
String version
Skill version or 'latest' for most recent version
class BetaSkillParams:
Specification for a skill to be loaded in a container (request model).
String skillId
Skill ID
Type type
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Optional<String> version
Skill version or 'latest' for most recent version
enum BetaStopReason:
class BetaTextBlock:
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "text"constant"text"constant
class BetaTextBlockParam:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaTextCitation: A class that can be one of several variants.union
class BetaCitationCharLocation:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaTextCitationParam: A class that can be one of several variants.union
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaTextDelta:
JsonValue; type "text_delta"constant"text_delta"constant
class BetaTextEditorCodeExecutionCreateResultBlock:
JsonValue; type "text_editor_code_execution_create_result"constant"text_editor_code_execution_create_result"constant
class BetaTextEditorCodeExecutionCreateResultBlockParam:
JsonValue; type "text_editor_code_execution_create_result"constant"text_editor_code_execution_create_result"constant
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
JsonValue; type "text_editor_code_execution_str_replace_result"constant"text_editor_code_execution_str_replace_result"constant
class BetaTextEditorCodeExecutionStrReplaceResultBlockParam:
JsonValue; type "text_editor_code_execution_str_replace_result"constant"text_editor_code_execution_str_replace_result"constant
class BetaTextEditorCodeExecutionToolResultBlock:
Content content
class BetaTextEditorCodeExecutionToolResultError:
ErrorCode errorCode
JsonValue; type "text_editor_code_execution_tool_result_error"constant"text_editor_code_execution_tool_result_error"constant
class BetaTextEditorCodeExecutionViewResultBlock:
FileType fileType
JsonValue; type "text_editor_code_execution_view_result"constant"text_editor_code_execution_view_result"constant
class BetaTextEditorCodeExecutionCreateResultBlock:
JsonValue; type "text_editor_code_execution_create_result"constant"text_editor_code_execution_create_result"constant
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
JsonValue; type "text_editor_code_execution_str_replace_result"constant"text_editor_code_execution_str_replace_result"constant
JsonValue; type "text_editor_code_execution_tool_result"constant"text_editor_code_execution_tool_result"constant
class BetaTextEditorCodeExecutionToolResultBlockParam:
Content content
class BetaTextEditorCodeExecutionToolResultErrorParam:
ErrorCode errorCode
JsonValue; type "text_editor_code_execution_tool_result_error"constant"text_editor_code_execution_tool_result_error"constant
class BetaTextEditorCodeExecutionViewResultBlockParam:
FileType fileType
JsonValue; type "text_editor_code_execution_view_result"constant"text_editor_code_execution_view_result"constant
class BetaTextEditorCodeExecutionCreateResultBlockParam:
JsonValue; type "text_editor_code_execution_create_result"constant"text_editor_code_execution_create_result"constant
class BetaTextEditorCodeExecutionStrReplaceResultBlockParam:
JsonValue; type "text_editor_code_execution_str_replace_result"constant"text_editor_code_execution_str_replace_result"constant
JsonValue; type "text_editor_code_execution_tool_result"constant"text_editor_code_execution_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaTextEditorCodeExecutionToolResultError:
ErrorCode errorCode
JsonValue; type "text_editor_code_execution_tool_result_error"constant"text_editor_code_execution_tool_result_error"constant
class BetaTextEditorCodeExecutionToolResultErrorParam:
ErrorCode errorCode
JsonValue; type "text_editor_code_execution_tool_result_error"constant"text_editor_code_execution_tool_result_error"constant
class BetaTextEditorCodeExecutionViewResultBlock:
FileType fileType
JsonValue; type "text_editor_code_execution_view_result"constant"text_editor_code_execution_view_result"constant
class BetaTextEditorCodeExecutionViewResultBlockParam:
FileType fileType
JsonValue; type "text_editor_code_execution_view_result"constant"text_editor_code_execution_view_result"constant
class BetaThinkingBlock:
JsonValue; type "thinking"constant"thinking"constant
class BetaThinkingBlockParam:
JsonValue; type "thinking"constant"thinking"constant
class BetaThinkingConfigDisabled:
JsonValue; type "disabled"constant"disabled"constant
class BetaThinkingConfigEnabled:
long budgetTokens
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.
JsonValue; type "enabled"constant"enabled"constant
class BetaThinkingConfigParam: A class that can be one of several variants.union
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:
long budgetTokens
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.
JsonValue; type "enabled"constant"enabled"constant
class BetaThinkingConfigDisabled:
JsonValue; type "disabled"constant"disabled"constant
class BetaThinkingDelta:
JsonValue; type "thinking_delta"constant"thinking_delta"constant
class BetaThinkingTurns:
JsonValue; type "thinking_turns"constant"thinking_turns"constant
class BetaTool:
InputSchema inputSchema
JSON schema for this tool's input.
This defines the shape of the input that your tool accepts and that the model will produce.
JsonValue; type "object"constant"object"constant
String name
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Optional<String> description
Description of what this tool does.
Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema.
Optional<Type> type
class BetaToolBash20241022:
JsonValue; name "bash"constant"bash"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "bash_20241022"constant"bash_20241022"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolBash20250124:
JsonValue; name "bash"constant"bash"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "bash_20250124"constant"bash_20250124"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
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.
class BetaToolChoiceAuto:
The model will automatically decide whether to use tools.
JsonValue; type "auto"constant"auto"constant
Optional<Boolean> disableParallelToolUse
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.
JsonValue; type "any"constant"any"constant
Optional<Boolean> disableParallelToolUse
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.
String name
The name of the tool to use.
JsonValue; type "tool"constant"tool"constant
Optional<Boolean> disableParallelToolUse
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.
JsonValue; type "none"constant"none"constant
class BetaToolChoiceAny:
The model will use any available tools.
JsonValue; type "any"constant"any"constant
Optional<Boolean> disableParallelToolUse
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.
JsonValue; type "auto"constant"auto"constant
Optional<Boolean> disableParallelToolUse
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.
JsonValue; type "none"constant"none"constant
class BetaToolChoiceTool:
The model will use the specified tool with tool_choice.name.
String name
The name of the tool to use.
JsonValue; type "tool"constant"tool"constant
Optional<Boolean> disableParallelToolUse
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
class BetaToolComputerUse20241022:
long displayHeightPx
The height of the display in pixels.
long displayWidthPx
The width of the display in pixels.
JsonValue; name "computer"constant"computer"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "computer_20241022"constant"computer_20241022"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Optional<Long> displayNumber
The X11 display number (e.g. 0, 1) for the display.
class BetaToolComputerUse20250124:
long displayHeightPx
The height of the display in pixels.
long displayWidthPx
The width of the display in pixels.
JsonValue; name "computer"constant"computer"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "computer_20250124"constant"computer_20250124"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Optional<Long> displayNumber
The X11 display number (e.g. 0, 1) for the display.
class BetaToolComputerUse20251124:
long displayHeightPx
The height of the display in pixels.
long displayWidthPx
The width of the display in pixels.
JsonValue; name "computer"constant"computer"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "computer_20251124"constant"computer_20251124"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Optional<Long> displayNumber
The X11 display number (e.g. 0, 1) for the display.
Optional<Boolean> enableZoom
Whether to enable an action to take a zoomed-in screenshot of the screen.
class BetaToolReferenceBlock:
JsonValue; type "tool_reference"constant"tool_reference"constant
class BetaToolReferenceBlockParam:
Tool reference block that can be included in tool_result content.
JsonValue; type "tool_reference"constant"tool_reference"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaToolResultBlockParam:
JsonValue; type "tool_result"constant"tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Content> content
List<Block>
class BetaTextBlockParam:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaSearchResultBlockParam:
List<BetaTextBlockParam> content
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "search_result"constant"search_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaRequestDocumentBlock:
Source source
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
class BetaContentBlockSource:
Content content
class BetaTextBlockParam:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "content"constant"content"constant
class BetaUrlPdfSource:
JsonValue; type "url"constant"url"constant
class BetaFileDocumentSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "document"constant"document"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaToolReferenceBlockParam:
Tool reference block that can be included in tool_result content.
JsonValue; type "tool_reference"constant"tool_reference"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaToolSearchToolBm25_20251119:
JsonValue; name "tool_search_tool_bm25"constant"tool_search_tool_bm25"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Type type
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolSearchToolRegex20251119:
JsonValue; name "tool_search_tool_regex"constant"tool_search_tool_regex"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Type type
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolSearchToolResultBlock:
Content content
class BetaToolSearchToolResultError:
ErrorCode errorCode
JsonValue; type "tool_search_tool_result_error"constant"tool_search_tool_result_error"constant
class BetaToolSearchToolSearchResultBlock:
List<BetaToolReferenceBlock> toolReferences
JsonValue; type "tool_reference"constant"tool_reference"constant
JsonValue; type "tool_search_tool_search_result"constant"tool_search_tool_search_result"constant
JsonValue; type "tool_search_tool_result"constant"tool_search_tool_result"constant
class BetaToolSearchToolResultBlockParam:
Content content
class BetaToolSearchToolResultErrorParam:
ErrorCode errorCode
JsonValue; type "tool_search_tool_result_error"constant"tool_search_tool_result_error"constant
class BetaToolSearchToolSearchResultBlockParam:
List<BetaToolReferenceBlockParam> toolReferences
JsonValue; type "tool_reference"constant"tool_reference"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "tool_search_tool_search_result"constant"tool_search_tool_search_result"constant
JsonValue; type "tool_search_tool_result"constant"tool_search_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaToolSearchToolResultError:
ErrorCode errorCode
JsonValue; type "tool_search_tool_result_error"constant"tool_search_tool_result_error"constant
class BetaToolSearchToolResultErrorParam:
ErrorCode errorCode
JsonValue; type "tool_search_tool_result_error"constant"tool_search_tool_result_error"constant
class BetaToolSearchToolSearchResultBlock:
List<BetaToolReferenceBlock> toolReferences
JsonValue; type "tool_reference"constant"tool_reference"constant
JsonValue; type "tool_search_tool_search_result"constant"tool_search_tool_search_result"constant
class BetaToolSearchToolSearchResultBlockParam:
List<BetaToolReferenceBlockParam> toolReferences
JsonValue; type "tool_reference"constant"tool_reference"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "tool_search_tool_search_result"constant"tool_search_tool_search_result"constant
class BetaToolTextEditor20241022:
JsonValue; name "str_replace_editor"constant"str_replace_editor"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "text_editor_20241022"constant"text_editor_20241022"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolTextEditor20250124:
JsonValue; name "str_replace_editor"constant"str_replace_editor"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "text_editor_20250124"constant"text_editor_20250124"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolTextEditor20250429:
JsonValue; name "str_replace_based_edit_tool"constant"str_replace_based_edit_tool"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "text_editor_20250429"constant"text_editor_20250429"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolTextEditor20250728:
JsonValue; name "str_replace_based_edit_tool"constant"str_replace_based_edit_tool"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "text_editor_20250728"constant"text_editor_20250728"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Optional<Long> maxCharacters
Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.
class BetaToolUnion: A class that can be one of several variants.union
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.
class BetaTool:
InputSchema inputSchema
JSON schema for this tool's input.
This defines the shape of the input that your tool accepts and that the model will produce.
JsonValue; type "object"constant"object"constant
String name
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Optional<String> description
Description of what this tool does.
Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema.
Optional<Type> type
class BetaToolBash20241022:
JsonValue; name "bash"constant"bash"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "bash_20241022"constant"bash_20241022"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolBash20250124:
JsonValue; name "bash"constant"bash"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "bash_20250124"constant"bash_20250124"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaCodeExecutionTool20250522:
JsonValue; name "code_execution"constant"code_execution"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "code_execution_20250522"constant"code_execution_20250522"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaCodeExecutionTool20250825:
JsonValue; name "code_execution"constant"code_execution"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolComputerUse20241022:
long displayHeightPx
The height of the display in pixels.
long displayWidthPx
The width of the display in pixels.
JsonValue; name "computer"constant"computer"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "computer_20241022"constant"computer_20241022"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Optional<Long> displayNumber
The X11 display number (e.g. 0, 1) for the display.
class BetaMemoryTool20250818:
JsonValue; name "memory"constant"memory"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "memory_20250818"constant"memory_20250818"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolComputerUse20250124:
long displayHeightPx
The height of the display in pixels.
long displayWidthPx
The width of the display in pixels.
JsonValue; name "computer"constant"computer"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "computer_20250124"constant"computer_20250124"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Optional<Long> displayNumber
The X11 display number (e.g. 0, 1) for the display.
class BetaToolTextEditor20241022:
JsonValue; name "str_replace_editor"constant"str_replace_editor"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "text_editor_20241022"constant"text_editor_20241022"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolComputerUse20251124:
long displayHeightPx
The height of the display in pixels.
long displayWidthPx
The width of the display in pixels.
JsonValue; name "computer"constant"computer"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "computer_20251124"constant"computer_20251124"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Optional<Long> displayNumber
The X11 display number (e.g. 0, 1) for the display.
Optional<Boolean> enableZoom
Whether to enable an action to take a zoomed-in screenshot of the screen.
class BetaToolTextEditor20250124:
JsonValue; name "str_replace_editor"constant"str_replace_editor"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "text_editor_20250124"constant"text_editor_20250124"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolTextEditor20250429:
JsonValue; name "str_replace_based_edit_tool"constant"str_replace_based_edit_tool"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "text_editor_20250429"constant"text_editor_20250429"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolTextEditor20250728:
JsonValue; name "str_replace_based_edit_tool"constant"str_replace_based_edit_tool"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "text_editor_20250728"constant"text_editor_20250728"constant
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Optional<Long> maxCharacters
Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.
class BetaWebSearchTool20250305:
JsonValue; name "web_search"constant"web_search"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "web_search_20250305"constant"web_search_20250305"constant
Optional<List<AllowedCaller>> allowedCallers
Optional<List<String>> allowedDomains
If provided, only these domains will be included in results. Cannot be used alongside blocked_domains.
Optional<List<String>> blockedDomains
If provided, these domains will never appear in results. Cannot be used alongside allowed_domains.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Optional<Long> maxUses
Maximum number of times the tool can be used in the API request.
Optional<UserLocation> userLocation
Parameters for the user's location. Used to provide more relevant search results.
JsonValue; type "approximate"constant"approximate"constant
Optional<String> city
The city of the user.
Optional<String> country
The two letter ISO country code of the user.
Optional<String> region
The region of the user.
Optional<String> timezone
The IANA timezone of the user.
class BetaWebFetchTool20250910:
JsonValue; name "web_fetch"constant"web_fetch"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "web_fetch_20250910"constant"web_fetch_20250910"constant
Optional<List<AllowedCaller>> allowedCallers
Optional<List<String>> allowedDomains
List of domains to allow fetching from
Optional<List<String>> blockedDomains
List of domains to block fetching from
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Citations configuration for fetched documents. Citations are disabled by default.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Optional<Long> maxContentTokens
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.
Optional<Long> maxUses
Maximum number of times the tool can be used in the API request.
class BetaToolSearchToolBm25_20251119:
JsonValue; name "tool_search_tool_bm25"constant"tool_search_tool_bm25"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Type type
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaToolSearchToolRegex20251119:
JsonValue; name "tool_search_tool_regex"constant"tool_search_tool_regex"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Type type
Optional<List<AllowedCaller>> allowedCallers
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
class BetaMcpToolset:
Configuration for a group of tools from an MCP server.
Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides.
String mcpServerName
Name of the MCP server to configure tools for
JsonValue; type "mcp_toolset"constant"mcp_toolset"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Configs> configs
Configuration overrides for specific tools, keyed by tool name
Default configuration applied to all tools from this server
class BetaToolUseBlock:
JsonValue; type "tool_use"constant"tool_use"constant
Optional<Caller> caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
class BetaToolUseBlockParam:
JsonValue; type "tool_use"constant"tool_use"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Caller> caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
class BetaToolUsesKeep:
JsonValue; type "tool_uses"constant"tool_uses"constant
class BetaToolUsesTrigger:
JsonValue; type "tool_uses"constant"tool_uses"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaUrlPdfSource:
JsonValue; type "url"constant"url"constant
class BetaUsage:
Breakdown of cached tokens by TTL
long ephemeral1hInputTokens
The number of input tokens used to create the 1 hour cache entry.
long ephemeral5mInputTokens
The number of input tokens used to create the 5 minute cache entry.
Optional<Long> cacheCreationInputTokens
The number of input tokens used to create the cache entry.
Optional<Long> cacheReadInputTokens
The number of input tokens read from the cache.
long inputTokens
The number of input tokens which were used.
long outputTokens
The number of output tokens which were used.
The number of server tool requests.
long webFetchRequests
The number of web fetch tool requests.
long webSearchRequests
The number of web search tool requests.
Optional<ServiceTier> serviceTier
If the request used the priority, standard, or batch tier.
class BetaWebFetchBlock:
BetaDocumentBlock content
Citation configuration for the document
Source source
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
Optional<String> title
The title of the document
JsonValue; type "document"constant"document"constant
Optional<String> retrievedAt
ISO 8601 timestamp when the content was retrieved
JsonValue; type "web_fetch_result"constant"web_fetch_result"constant
String url
Fetched content URL
class BetaWebFetchBlockParam:
BetaRequestDocumentBlock content
Source source
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
class BetaContentBlockSource:
Content content
class BetaTextBlockParam:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "content"constant"content"constant
class BetaUrlPdfSource:
JsonValue; type "url"constant"url"constant
class BetaFileDocumentSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "document"constant"document"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "web_fetch_result"constant"web_fetch_result"constant
String url
Fetched content URL
Optional<String> retrievedAt
ISO 8601 timestamp when the content was retrieved
class BetaWebFetchTool20250910:
JsonValue; name "web_fetch"constant"web_fetch"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "web_fetch_20250910"constant"web_fetch_20250910"constant
Optional<List<AllowedCaller>> allowedCallers
Optional<List<String>> allowedDomains
List of domains to allow fetching from
Optional<List<String>> blockedDomains
List of domains to block fetching from
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Citations configuration for fetched documents. Citations are disabled by default.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Optional<Long> maxContentTokens
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.
Optional<Long> maxUses
Maximum number of times the tool can be used in the API request.
class BetaWebFetchToolResultBlock:
Content content
class BetaWebFetchToolResultErrorBlock:
BetaWebFetchToolResultErrorCode errorCode
JsonValue; type "web_fetch_tool_result_error"constant"web_fetch_tool_result_error"constant
class BetaWebFetchBlock:
BetaDocumentBlock content
Citation configuration for the document
Source source
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
Optional<String> title
The title of the document
JsonValue; type "document"constant"document"constant
Optional<String> retrievedAt
ISO 8601 timestamp when the content was retrieved
JsonValue; type "web_fetch_result"constant"web_fetch_result"constant
String url
Fetched content URL
JsonValue; type "web_fetch_tool_result"constant"web_fetch_tool_result"constant
class BetaWebFetchToolResultBlockParam:
Content content
class BetaWebFetchToolResultErrorBlockParam:
BetaWebFetchToolResultErrorCode errorCode
JsonValue; type "web_fetch_tool_result_error"constant"web_fetch_tool_result_error"constant
class BetaWebFetchBlockParam:
BetaRequestDocumentBlock content
Source source
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
class BetaContentBlockSource:
Content content
class BetaTextBlockParam:
JsonValue; type "text"constant"text"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocationParam:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocationParam:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationWebSearchResultLocationParam:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocationParam:
JsonValue; type "search_result_location"constant"search_result_location"constant
class BetaImageBlockParam:
Source source
class BetaBase64ImageSource:
MediaType mediaType
JsonValue; type "base64"constant"base64"constant
class BetaUrlImageSource:
JsonValue; type "url"constant"url"constant
class BetaFileImageSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "image"constant"image"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "content"constant"content"constant
class BetaUrlPdfSource:
JsonValue; type "url"constant"url"constant
class BetaFileDocumentSource:
JsonValue; type "file"constant"file"constant
JsonValue; type "document"constant"document"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
JsonValue; type "web_fetch_result"constant"web_fetch_result"constant
String url
Fetched content URL
Optional<String> retrievedAt
ISO 8601 timestamp when the content was retrieved
JsonValue; type "web_fetch_tool_result"constant"web_fetch_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaWebFetchToolResultErrorBlock:
BetaWebFetchToolResultErrorCode errorCode
JsonValue; type "web_fetch_tool_result_error"constant"web_fetch_tool_result_error"constant
class BetaWebFetchToolResultErrorBlockParam:
BetaWebFetchToolResultErrorCode errorCode
JsonValue; type "web_fetch_tool_result_error"constant"web_fetch_tool_result_error"constant
enum BetaWebFetchToolResultErrorCode:
class BetaWebSearchResultBlock:
JsonValue; type "web_search_result"constant"web_search_result"constant
class BetaWebSearchResultBlockParam:
JsonValue; type "web_search_result"constant"web_search_result"constant
class BetaWebSearchTool20250305:
JsonValue; name "web_search"constant"web_search"constant
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
JsonValue; type "web_search_20250305"constant"web_search_20250305"constant
Optional<List<AllowedCaller>> allowedCallers
Optional<List<String>> allowedDomains
If provided, only these domains will be included in results. Cannot be used alongside blocked_domains.
Optional<List<String>> blockedDomains
If provided, these domains will never appear in results. Cannot be used alongside allowed_domains.
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Optional<Boolean> deferLoading
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Optional<Long> maxUses
Maximum number of times the tool can be used in the API request.
Optional<UserLocation> userLocation
Parameters for the user's location. Used to provide more relevant search results.
JsonValue; type "approximate"constant"approximate"constant
Optional<String> city
The city of the user.
Optional<String> country
The two letter ISO country code of the user.
Optional<String> region
The region of the user.
Optional<String> timezone
The IANA timezone of the user.
class BetaWebSearchToolRequestError:
BetaWebSearchToolResultErrorCode errorCode
JsonValue; type "web_search_tool_result_error"constant"web_search_tool_result_error"constant
class BetaWebSearchToolResultBlock:
class BetaWebSearchToolResultError:
BetaWebSearchToolResultErrorCode errorCode
JsonValue; type "web_search_tool_result_error"constant"web_search_tool_result_error"constant
List<BetaWebSearchResultBlock>
JsonValue; type "web_search_result"constant"web_search_result"constant
JsonValue; type "web_search_tool_result"constant"web_search_tool_result"constant
class BetaWebSearchToolResultBlockContent: A class that can be one of several variants.union
class BetaWebSearchToolResultError:
BetaWebSearchToolResultErrorCode errorCode
JsonValue; type "web_search_tool_result_error"constant"web_search_tool_result_error"constant
List<BetaWebSearchResultBlock>
JsonValue; type "web_search_result"constant"web_search_result"constant
class BetaWebSearchToolResultBlockParam:
JsonValue; type "web_search_result"constant"web_search_result"constant
class BetaWebSearchToolRequestError:
BetaWebSearchToolResultErrorCode errorCode
JsonValue; type "web_search_tool_result_error"constant"web_search_tool_result_error"constant
JsonValue; type "web_search_tool_result"constant"web_search_tool_result"constant
Create a cache control breakpoint at this content block.
JsonValue; type "ephemeral"constant"ephemeral"constant
Optional<Ttl> ttl
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaWebSearchToolResultBlockParamContent: A class that can be one of several variants.union
JsonValue; type "web_search_result"constant"web_search_result"constant
class BetaWebSearchToolRequestError:
BetaWebSearchToolResultErrorCode errorCode
JsonValue; type "web_search_tool_result_error"constant"web_search_tool_result_error"constant
class BetaWebSearchToolResultError:
BetaWebSearchToolResultErrorCode errorCode
JsonValue; type "web_search_tool_result_error"constant"web_search_tool_result_error"constant
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:
String id
ID of the Message Batch.
JsonValue; type "message_batch_deleted"constant"message_batch_deleted"constant
Deleted object type.
For Message Batches, this is always "message_batch_deleted".
class BetaMessageBatch:
String id
Unique object identifier.
The format and length of IDs may change over time.
Optional<LocalDateTime> archivedAt
RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.
Optional<LocalDateTime> cancelInitiatedAt
RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated.
LocalDateTime createdAt
RFC 3339 datetime string representing the time at which the Message Batch was created.
Optional<LocalDateTime> endedAt
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.
LocalDateTime expiresAt
RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation.
ProcessingStatus processingStatus
Processing status of the Message Batch.
BetaMessageBatchRequestCounts requestCounts
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.
long canceled
Number of requests in the Message Batch that have been canceled.
This is zero until processing of the entire Message Batch has ended.
long errored
Number of requests in the Message Batch that encountered an error.
This is zero until processing of the entire Message Batch has ended.
long expired
Number of requests in the Message Batch that have expired.
This is zero until processing of the entire Message Batch has ended.
long processing
Number of requests in the Message Batch that are processing.
long succeeded
Number of requests in the Message Batch that have completed successfully.
This is zero until processing of the entire Message Batch has ended.
Optional<String> resultsUrl
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.
JsonValue; type "message_batch"constant"message_batch"constant
Object type.
For Message Batches, this is always "message_batch".
class BetaMessageBatchCanceledResult:
JsonValue; type "canceled"constant"canceled"constant
class BetaMessageBatchErroredResult:
BetaErrorResponse error
BetaError error
class BetaInvalidRequestError:
JsonValue; type "invalid_request_error"constant"invalid_request_error"constant
class BetaAuthenticationError:
JsonValue; type "authentication_error"constant"authentication_error"constant
class BetaBillingError:
JsonValue; type "billing_error"constant"billing_error"constant
class BetaPermissionError:
JsonValue; type "permission_error"constant"permission_error"constant
class BetaNotFoundError:
JsonValue; type "not_found_error"constant"not_found_error"constant
class BetaRateLimitError:
JsonValue; type "rate_limit_error"constant"rate_limit_error"constant
class BetaGatewayTimeoutError:
JsonValue; type "timeout_error"constant"timeout_error"constant
class BetaApiError:
JsonValue; type "api_error"constant"api_error"constant
class BetaOverloadedError:
JsonValue; type "overloaded_error"constant"overloaded_error"constant
JsonValue; type "error"constant"error"constant
JsonValue; type "errored"constant"errored"constant
class BetaMessageBatchExpiredResult:
JsonValue; type "expired"constant"expired"constant
class BetaMessageBatchIndividualResponse:
This is a single line in the response .jsonl file and does not represent the response as a whole.
String customId
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.
BetaMessageBatchResult result
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:
BetaMessage message
String id
Unique object identifier.
The format and length of IDs may change over time.
Information about the container used in the request (for the code execution tool)
String id
Identifier for the container used in this request
LocalDateTime expiresAt
The time at which the container will expire.
Skills loaded in the container
String skillId
Skill ID
Type type
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
String version
Skill version or 'latest' for most recent version
List<BetaContentBlock> content
Content generated by the model.
This is an array of content blocks, each of which has a type that determines its shape.
Example:
[{"type": "text", "text": "Hi, I'm Claude."}]
If the request input messages ended with an assistant turn, then the response content will continue directly from that last turn. You can use this to constrain the model's output.
For example, if the input messages were:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("}
]
Then the response content might be:
[{"type": "text", "text": "B)"}]
class BetaTextBlock:
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "text"constant"text"constant
class BetaThinkingBlock:
JsonValue; type "thinking"constant"thinking"constant
class BetaRedactedThinkingBlock:
JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
class BetaToolUseBlock:
JsonValue; type "tool_use"constant"tool_use"constant
Optional<Caller> caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
class BetaServerToolUseBlock:
Caller caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
Name name
JsonValue; type "server_tool_use"constant"server_tool_use"constant
class BetaWebSearchToolResultBlock:
class BetaWebSearchToolResultError:
BetaWebSearchToolResultErrorCode errorCode
JsonValue; type "web_search_tool_result_error"constant"web_search_tool_result_error"constant
List<BetaWebSearchResultBlock>
JsonValue; type "web_search_result"constant"web_search_result"constant
JsonValue; type "web_search_tool_result"constant"web_search_tool_result"constant
class BetaWebFetchToolResultBlock:
Content content
class BetaWebFetchToolResultErrorBlock:
BetaWebFetchToolResultErrorCode errorCode
JsonValue; type "web_fetch_tool_result_error"constant"web_fetch_tool_result_error"constant
class BetaWebFetchBlock:
BetaDocumentBlock content
Citation configuration for the document
Source source
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
Optional<String> title
The title of the document
JsonValue; type "document"constant"document"constant
Optional<String> retrievedAt
ISO 8601 timestamp when the content was retrieved
JsonValue; type "web_fetch_result"constant"web_fetch_result"constant
String url
Fetched content URL
JsonValue; type "web_fetch_tool_result"constant"web_fetch_tool_result"constant
class BetaCodeExecutionToolResultBlock:
class BetaCodeExecutionToolResultError:
BetaCodeExecutionToolResultErrorCode errorCode
JsonValue; type "code_execution_tool_result_error"constant"code_execution_tool_result_error"constant
class BetaCodeExecutionResultBlock:
List<BetaCodeExecutionOutputBlock> content
JsonValue; type "code_execution_output"constant"code_execution_output"constant
JsonValue; type "code_execution_result"constant"code_execution_result"constant
JsonValue; type "code_execution_tool_result"constant"code_execution_tool_result"constant
class BetaBashCodeExecutionToolResultBlock:
Content content
class BetaBashCodeExecutionToolResultError:
ErrorCode errorCode
JsonValue; type "bash_code_execution_tool_result_error"constant"bash_code_execution_tool_result_error"constant
class BetaBashCodeExecutionResultBlock:
List<BetaBashCodeExecutionOutputBlock> content
JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
JsonValue; type "bash_code_execution_tool_result"constant"bash_code_execution_tool_result"constant
class BetaTextEditorCodeExecutionToolResultBlock:
Content content
class BetaTextEditorCodeExecutionToolResultError:
ErrorCode errorCode
JsonValue; type "text_editor_code_execution_tool_result_error"constant"text_editor_code_execution_tool_result_error"constant
class BetaTextEditorCodeExecutionViewResultBlock:
FileType fileType
JsonValue; type "text_editor_code_execution_view_result"constant"text_editor_code_execution_view_result"constant
class BetaTextEditorCodeExecutionCreateResultBlock:
JsonValue; type "text_editor_code_execution_create_result"constant"text_editor_code_execution_create_result"constant
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
JsonValue; type "text_editor_code_execution_str_replace_result"constant"text_editor_code_execution_str_replace_result"constant
JsonValue; type "text_editor_code_execution_tool_result"constant"text_editor_code_execution_tool_result"constant
class BetaToolSearchToolResultBlock:
Content content
class BetaToolSearchToolResultError:
ErrorCode errorCode
JsonValue; type "tool_search_tool_result_error"constant"tool_search_tool_result_error"constant
class BetaToolSearchToolSearchResultBlock:
List<BetaToolReferenceBlock> toolReferences
JsonValue; type "tool_reference"constant"tool_reference"constant
JsonValue; type "tool_search_tool_search_result"constant"tool_search_tool_search_result"constant
JsonValue; type "tool_search_tool_result"constant"tool_search_tool_result"constant
class BetaMcpToolUseBlock:
String name
The name of the MCP tool
String serverName
The name of the MCP server
JsonValue; type "mcp_tool_use"constant"mcp_tool_use"constant
class BetaMcpToolResultBlock:
Content content
List<BetaTextBlock>
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "text"constant"text"constant
JsonValue; type "mcp_tool_result"constant"mcp_tool_result"constant
class BetaContainerUploadBlock:
Response model for a file uploaded to the container.
JsonValue; type "container_upload"constant"container_upload"constant
Context management response.
Information about context management strategies applied during the request.
List<AppliedEdit> appliedEdits
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse:
long clearedInputTokens
Number of input tokens cleared by this edit.
long clearedToolUses
Number of tool uses that were cleared.
JsonValue; type "clear_tool_uses_20250919"constant"clear_tool_uses_20250919"constant
The type of context management edit applied.
class BetaClearThinking20251015EditResponse:
long clearedInputTokens
Number of input tokens cleared by this edit.
long clearedThinkingTurns
Number of thinking turns that were cleared.
JsonValue; type "clear_thinking_20251015"constant"clear_thinking_20251015"constant
The type of context management edit applied.
Model model
The model that will complete your prompt.
See models for additional details and options.
CLAUDE_OPUS_4_5_20251101("claude-opus-4-5-20251101")
Premium model combining maximum intelligence with practical performance
CLAUDE_OPUS_4_5("claude-opus-4-5")
Premium model combining maximum intelligence with practical performance
CLAUDE_3_7_SONNET_LATEST("claude-3-7-sonnet-latest")
High-performance model with early extended thinking
CLAUDE_3_7_SONNET_20250219("claude-3-7-sonnet-20250219")
High-performance model with early extended thinking
CLAUDE_3_5_HAIKU_LATEST("claude-3-5-haiku-latest")
Fastest and most compact model for near-instant responsiveness
CLAUDE_3_5_HAIKU_20241022("claude-3-5-haiku-20241022")
Our fastest model
CLAUDE_HAIKU_4_5("claude-haiku-4-5")
Hybrid model, capable of near-instant responses and extended thinking
CLAUDE_HAIKU_4_5_20251001("claude-haiku-4-5-20251001")
Hybrid model, capable of near-instant responses and extended thinking
CLAUDE_SONNET_4_20250514("claude-sonnet-4-20250514")
High-performance model with extended thinking
CLAUDE_SONNET_4_0("claude-sonnet-4-0")
High-performance model with extended thinking
CLAUDE_4_SONNET_20250514("claude-4-sonnet-20250514")
High-performance model with extended thinking
CLAUDE_SONNET_4_5("claude-sonnet-4-5")
Our best model for real-world agents and coding
CLAUDE_SONNET_4_5_20250929("claude-sonnet-4-5-20250929")
Our best model for real-world agents and coding
CLAUDE_OPUS_4_0("claude-opus-4-0")
Our most capable model
CLAUDE_OPUS_4_20250514("claude-opus-4-20250514")
Our most capable model
CLAUDE_4_OPUS_20250514("claude-4-opus-20250514")
Our most capable model
CLAUDE_OPUS_4_1_20250805("claude-opus-4-1-20250805")
Our most capable model
CLAUDE_3_OPUS_LATEST("claude-3-opus-latest")
Excels at writing and complex tasks
CLAUDE_3_OPUS_20240229("claude-3-opus-20240229")
Excels at writing and complex tasks
CLAUDE_3_HAIKU_20240307("claude-3-haiku-20240307")
Our previous most fast and cost-effective
JsonValue; role "assistant"constant"assistant"constant
Conversational role of the generated message.
This will always be "assistant".
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
Optional<String> stopSequence
Which custom stop sequence was generated, if any.
This value will be a non-null string if one of your custom stop sequences was generated.
JsonValue; type "message"constant"message"constant
Object type.
For Messages, this is always "message".
BetaUsage 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.
Breakdown of cached tokens by TTL
long ephemeral1hInputTokens
The number of input tokens used to create the 1 hour cache entry.
long ephemeral5mInputTokens
The number of input tokens used to create the 5 minute cache entry.
Optional<Long> cacheCreationInputTokens
The number of input tokens used to create the cache entry.
Optional<Long> cacheReadInputTokens
The number of input tokens read from the cache.
long inputTokens
The number of input tokens which were used.
long outputTokens
The number of output tokens which were used.
The number of server tool requests.
long webFetchRequests
The number of web fetch tool requests.
long webSearchRequests
The number of web search tool requests.
Optional<ServiceTier> serviceTier
If the request used the priority, standard, or batch tier.
JsonValue; type "succeeded"constant"succeeded"constant
class BetaMessageBatchErroredResult:
BetaErrorResponse error
BetaError error
class BetaInvalidRequestError:
JsonValue; type "invalid_request_error"constant"invalid_request_error"constant
class BetaAuthenticationError:
JsonValue; type "authentication_error"constant"authentication_error"constant
class BetaBillingError:
JsonValue; type "billing_error"constant"billing_error"constant
class BetaPermissionError:
JsonValue; type "permission_error"constant"permission_error"constant
class BetaNotFoundError:
JsonValue; type "not_found_error"constant"not_found_error"constant
class BetaRateLimitError:
JsonValue; type "rate_limit_error"constant"rate_limit_error"constant
class BetaGatewayTimeoutError:
JsonValue; type "timeout_error"constant"timeout_error"constant
class BetaApiError:
JsonValue; type "api_error"constant"api_error"constant
class BetaOverloadedError:
JsonValue; type "overloaded_error"constant"overloaded_error"constant
JsonValue; type "error"constant"error"constant
JsonValue; type "errored"constant"errored"constant
class BetaMessageBatchCanceledResult:
JsonValue; type "canceled"constant"canceled"constant
class BetaMessageBatchExpiredResult:
JsonValue; type "expired"constant"expired"constant
class BetaMessageBatchRequestCounts:
long canceled
Number of requests in the Message Batch that have been canceled.
This is zero until processing of the entire Message Batch has ended.
long errored
Number of requests in the Message Batch that encountered an error.
This is zero until processing of the entire Message Batch has ended.
long expired
Number of requests in the Message Batch that have expired.
This is zero until processing of the entire Message Batch has ended.
long processing
Number of requests in the Message Batch that are processing.
long succeeded
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.
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:
BetaMessage message
String id
Unique object identifier.
The format and length of IDs may change over time.
Information about the container used in the request (for the code execution tool)
String id
Identifier for the container used in this request
LocalDateTime expiresAt
The time at which the container will expire.
Skills loaded in the container
String skillId
Skill ID
Type type
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
String version
Skill version or 'latest' for most recent version
List<BetaContentBlock> content
Content generated by the model.
This is an array of content blocks, each of which has a type that determines its shape.
Example:
[{"type": "text", "text": "Hi, I'm Claude."}]
If the request input messages ended with an assistant turn, then the response content will continue directly from that last turn. You can use this to constrain the model's output.
For example, if the input messages were:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("}
]
Then the response content might be:
[{"type": "text", "text": "B)"}]
class BetaTextBlock:
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "text"constant"text"constant
class BetaThinkingBlock:
JsonValue; type "thinking"constant"thinking"constant
class BetaRedactedThinkingBlock:
JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
class BetaToolUseBlock:
JsonValue; type "tool_use"constant"tool_use"constant
Optional<Caller> caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
class BetaServerToolUseBlock:
Caller caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
Name name
JsonValue; type "server_tool_use"constant"server_tool_use"constant
class BetaWebSearchToolResultBlock:
class BetaWebSearchToolResultError:
BetaWebSearchToolResultErrorCode errorCode
JsonValue; type "web_search_tool_result_error"constant"web_search_tool_result_error"constant
List<BetaWebSearchResultBlock>
JsonValue; type "web_search_result"constant"web_search_result"constant
JsonValue; type "web_search_tool_result"constant"web_search_tool_result"constant
class BetaWebFetchToolResultBlock:
Content content
class BetaWebFetchToolResultErrorBlock:
BetaWebFetchToolResultErrorCode errorCode
JsonValue; type "web_fetch_tool_result_error"constant"web_fetch_tool_result_error"constant
class BetaWebFetchBlock:
BetaDocumentBlock content
Citation configuration for the document
Source source
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
Optional<String> title
The title of the document
JsonValue; type "document"constant"document"constant
Optional<String> retrievedAt
ISO 8601 timestamp when the content was retrieved
JsonValue; type "web_fetch_result"constant"web_fetch_result"constant
String url
Fetched content URL
JsonValue; type "web_fetch_tool_result"constant"web_fetch_tool_result"constant
class BetaCodeExecutionToolResultBlock:
class BetaCodeExecutionToolResultError:
BetaCodeExecutionToolResultErrorCode errorCode
JsonValue; type "code_execution_tool_result_error"constant"code_execution_tool_result_error"constant
class BetaCodeExecutionResultBlock:
List<BetaCodeExecutionOutputBlock> content
JsonValue; type "code_execution_output"constant"code_execution_output"constant
JsonValue; type "code_execution_result"constant"code_execution_result"constant
JsonValue; type "code_execution_tool_result"constant"code_execution_tool_result"constant
class BetaBashCodeExecutionToolResultBlock:
Content content
class BetaBashCodeExecutionToolResultError:
ErrorCode errorCode
JsonValue; type "bash_code_execution_tool_result_error"constant"bash_code_execution_tool_result_error"constant
class BetaBashCodeExecutionResultBlock:
List<BetaBashCodeExecutionOutputBlock> content
JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
JsonValue; type "bash_code_execution_tool_result"constant"bash_code_execution_tool_result"constant
class BetaTextEditorCodeExecutionToolResultBlock:
Content content
class BetaTextEditorCodeExecutionToolResultError:
ErrorCode errorCode
JsonValue; type "text_editor_code_execution_tool_result_error"constant"text_editor_code_execution_tool_result_error"constant
class BetaTextEditorCodeExecutionViewResultBlock:
FileType fileType
JsonValue; type "text_editor_code_execution_view_result"constant"text_editor_code_execution_view_result"constant
class BetaTextEditorCodeExecutionCreateResultBlock:
JsonValue; type "text_editor_code_execution_create_result"constant"text_editor_code_execution_create_result"constant
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
JsonValue; type "text_editor_code_execution_str_replace_result"constant"text_editor_code_execution_str_replace_result"constant
JsonValue; type "text_editor_code_execution_tool_result"constant"text_editor_code_execution_tool_result"constant
class BetaToolSearchToolResultBlock:
Content content
class BetaToolSearchToolResultError:
ErrorCode errorCode
JsonValue; type "tool_search_tool_result_error"constant"tool_search_tool_result_error"constant
class BetaToolSearchToolSearchResultBlock:
List<BetaToolReferenceBlock> toolReferences
JsonValue; type "tool_reference"constant"tool_reference"constant
JsonValue; type "tool_search_tool_search_result"constant"tool_search_tool_search_result"constant
JsonValue; type "tool_search_tool_result"constant"tool_search_tool_result"constant
class BetaMcpToolUseBlock:
String name
The name of the MCP tool
String serverName
The name of the MCP server
JsonValue; type "mcp_tool_use"constant"mcp_tool_use"constant
class BetaMcpToolResultBlock:
Content content
List<BetaTextBlock>
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "text"constant"text"constant
JsonValue; type "mcp_tool_result"constant"mcp_tool_result"constant
class BetaContainerUploadBlock:
Response model for a file uploaded to the container.
JsonValue; type "container_upload"constant"container_upload"constant
Context management response.
Information about context management strategies applied during the request.
List<AppliedEdit> appliedEdits
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse:
long clearedInputTokens
Number of input tokens cleared by this edit.
long clearedToolUses
Number of tool uses that were cleared.
JsonValue; type "clear_tool_uses_20250919"constant"clear_tool_uses_20250919"constant
The type of context management edit applied.
class BetaClearThinking20251015EditResponse:
long clearedInputTokens
Number of input tokens cleared by this edit.
long clearedThinkingTurns
Number of thinking turns that were cleared.
JsonValue; type "clear_thinking_20251015"constant"clear_thinking_20251015"constant
The type of context management edit applied.
Model model
The model that will complete your prompt.
See models for additional details and options.
CLAUDE_OPUS_4_5_20251101("claude-opus-4-5-20251101")
Premium model combining maximum intelligence with practical performance
CLAUDE_OPUS_4_5("claude-opus-4-5")
Premium model combining maximum intelligence with practical performance
CLAUDE_3_7_SONNET_LATEST("claude-3-7-sonnet-latest")
High-performance model with early extended thinking
CLAUDE_3_7_SONNET_20250219("claude-3-7-sonnet-20250219")
High-performance model with early extended thinking
CLAUDE_3_5_HAIKU_LATEST("claude-3-5-haiku-latest")
Fastest and most compact model for near-instant responsiveness
CLAUDE_3_5_HAIKU_20241022("claude-3-5-haiku-20241022")
Our fastest model
CLAUDE_HAIKU_4_5("claude-haiku-4-5")
Hybrid model, capable of near-instant responses and extended thinking
CLAUDE_HAIKU_4_5_20251001("claude-haiku-4-5-20251001")
Hybrid model, capable of near-instant responses and extended thinking
CLAUDE_SONNET_4_20250514("claude-sonnet-4-20250514")
High-performance model with extended thinking
CLAUDE_SONNET_4_0("claude-sonnet-4-0")
High-performance model with extended thinking
CLAUDE_4_SONNET_20250514("claude-4-sonnet-20250514")
High-performance model with extended thinking
CLAUDE_SONNET_4_5("claude-sonnet-4-5")
Our best model for real-world agents and coding
CLAUDE_SONNET_4_5_20250929("claude-sonnet-4-5-20250929")
Our best model for real-world agents and coding
CLAUDE_OPUS_4_0("claude-opus-4-0")
Our most capable model
CLAUDE_OPUS_4_20250514("claude-opus-4-20250514")
Our most capable model
CLAUDE_4_OPUS_20250514("claude-4-opus-20250514")
Our most capable model
CLAUDE_OPUS_4_1_20250805("claude-opus-4-1-20250805")
Our most capable model
CLAUDE_3_OPUS_LATEST("claude-3-opus-latest")
Excels at writing and complex tasks
CLAUDE_3_OPUS_20240229("claude-3-opus-20240229")
Excels at writing and complex tasks
CLAUDE_3_HAIKU_20240307("claude-3-haiku-20240307")
Our previous most fast and cost-effective
JsonValue; role "assistant"constant"assistant"constant
Conversational role of the generated message.
This will always be "assistant".
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
Optional<String> stopSequence
Which custom stop sequence was generated, if any.
This value will be a non-null string if one of your custom stop sequences was generated.
JsonValue; type "message"constant"message"constant
Object type.
For Messages, this is always "message".
BetaUsage 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.
Breakdown of cached tokens by TTL
long ephemeral1hInputTokens
The number of input tokens used to create the 1 hour cache entry.
long ephemeral5mInputTokens
The number of input tokens used to create the 5 minute cache entry.
Optional<Long> cacheCreationInputTokens
The number of input tokens used to create the cache entry.
Optional<Long> cacheReadInputTokens
The number of input tokens read from the cache.
long inputTokens
The number of input tokens which were used.
long outputTokens
The number of output tokens which were used.
The number of server tool requests.
long webFetchRequests
The number of web fetch tool requests.
long webSearchRequests
The number of web search tool requests.
Optional<ServiceTier> serviceTier
If the request used the priority, standard, or batch tier.
JsonValue; type "succeeded"constant"succeeded"constant
class BetaMessageBatchErroredResult:
BetaErrorResponse error
BetaError error
class BetaInvalidRequestError:
JsonValue; type "invalid_request_error"constant"invalid_request_error"constant
class BetaAuthenticationError:
JsonValue; type "authentication_error"constant"authentication_error"constant
class BetaBillingError:
JsonValue; type "billing_error"constant"billing_error"constant
class BetaPermissionError:
JsonValue; type "permission_error"constant"permission_error"constant
class BetaNotFoundError:
JsonValue; type "not_found_error"constant"not_found_error"constant
class BetaRateLimitError:
JsonValue; type "rate_limit_error"constant"rate_limit_error"constant
class BetaGatewayTimeoutError:
JsonValue; type "timeout_error"constant"timeout_error"constant
class BetaApiError:
JsonValue; type "api_error"constant"api_error"constant
class BetaOverloadedError:
JsonValue; type "overloaded_error"constant"overloaded_error"constant
JsonValue; type "error"constant"error"constant
JsonValue; type "errored"constant"errored"constant
class BetaMessageBatchCanceledResult:
JsonValue; type "canceled"constant"canceled"constant
class BetaMessageBatchExpiredResult:
JsonValue; type "expired"constant"expired"constant
class BetaMessageBatchSucceededResult:
BetaMessage message
String id
Unique object identifier.
The format and length of IDs may change over time.
Information about the container used in the request (for the code execution tool)
String id
Identifier for the container used in this request
LocalDateTime expiresAt
The time at which the container will expire.
Skills loaded in the container
String skillId
Skill ID
Type type
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
String version
Skill version or 'latest' for most recent version
List<BetaContentBlock> content
Content generated by the model.
This is an array of content blocks, each of which has a type that determines its shape.
Example:
[{"type": "text", "text": "Hi, I'm Claude."}]
If the request input messages ended with an assistant turn, then the response content will continue directly from that last turn. You can use this to constrain the model's output.
For example, if the input messages were:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("}
]
Then the response content might be:
[{"type": "text", "text": "B)"}]
class BetaTextBlock:
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "text"constant"text"constant
class BetaThinkingBlock:
JsonValue; type "thinking"constant"thinking"constant
class BetaRedactedThinkingBlock:
JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
class BetaToolUseBlock:
JsonValue; type "tool_use"constant"tool_use"constant
Optional<Caller> caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
class BetaServerToolUseBlock:
Caller caller
Tool invocation directly from the model.
class BetaDirectCaller:
Tool invocation directly from the model.
JsonValue; type "direct"constant"direct"constant
class BetaServerToolCaller:
Tool invocation generated by a server-side tool.
JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
Name name
JsonValue; type "server_tool_use"constant"server_tool_use"constant
class BetaWebSearchToolResultBlock:
class BetaWebSearchToolResultError:
BetaWebSearchToolResultErrorCode errorCode
JsonValue; type "web_search_tool_result_error"constant"web_search_tool_result_error"constant
List<BetaWebSearchResultBlock>
JsonValue; type "web_search_result"constant"web_search_result"constant
JsonValue; type "web_search_tool_result"constant"web_search_tool_result"constant
class BetaWebFetchToolResultBlock:
Content content
class BetaWebFetchToolResultErrorBlock:
BetaWebFetchToolResultErrorCode errorCode
JsonValue; type "web_fetch_tool_result_error"constant"web_fetch_tool_result_error"constant
class BetaWebFetchBlock:
BetaDocumentBlock content
Citation configuration for the document
Source source
class BetaBase64PdfSource:
JsonValue; mediaType "application/pdf"constant"application/pdf"constant
JsonValue; type "base64"constant"base64"constant
class BetaPlainTextSource:
JsonValue; mediaType "text/plain"constant"text/plain"constant
JsonValue; type "text"constant"text"constant
Optional<String> title
The title of the document
JsonValue; type "document"constant"document"constant
Optional<String> retrievedAt
ISO 8601 timestamp when the content was retrieved
JsonValue; type "web_fetch_result"constant"web_fetch_result"constant
String url
Fetched content URL
JsonValue; type "web_fetch_tool_result"constant"web_fetch_tool_result"constant
class BetaCodeExecutionToolResultBlock:
class BetaCodeExecutionToolResultError:
BetaCodeExecutionToolResultErrorCode errorCode
JsonValue; type "code_execution_tool_result_error"constant"code_execution_tool_result_error"constant
class BetaCodeExecutionResultBlock:
List<BetaCodeExecutionOutputBlock> content
JsonValue; type "code_execution_output"constant"code_execution_output"constant
JsonValue; type "code_execution_result"constant"code_execution_result"constant
JsonValue; type "code_execution_tool_result"constant"code_execution_tool_result"constant
class BetaBashCodeExecutionToolResultBlock:
Content content
class BetaBashCodeExecutionToolResultError:
ErrorCode errorCode
JsonValue; type "bash_code_execution_tool_result_error"constant"bash_code_execution_tool_result_error"constant
class BetaBashCodeExecutionResultBlock:
List<BetaBashCodeExecutionOutputBlock> content
JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
JsonValue; type "bash_code_execution_tool_result"constant"bash_code_execution_tool_result"constant
class BetaTextEditorCodeExecutionToolResultBlock:
Content content
class BetaTextEditorCodeExecutionToolResultError:
ErrorCode errorCode
JsonValue; type "text_editor_code_execution_tool_result_error"constant"text_editor_code_execution_tool_result_error"constant
class BetaTextEditorCodeExecutionViewResultBlock:
FileType fileType
JsonValue; type "text_editor_code_execution_view_result"constant"text_editor_code_execution_view_result"constant
class BetaTextEditorCodeExecutionCreateResultBlock:
JsonValue; type "text_editor_code_execution_create_result"constant"text_editor_code_execution_create_result"constant
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
JsonValue; type "text_editor_code_execution_str_replace_result"constant"text_editor_code_execution_str_replace_result"constant
JsonValue; type "text_editor_code_execution_tool_result"constant"text_editor_code_execution_tool_result"constant
class BetaToolSearchToolResultBlock:
Content content
class BetaToolSearchToolResultError:
ErrorCode errorCode
JsonValue; type "tool_search_tool_result_error"constant"tool_search_tool_result_error"constant
class BetaToolSearchToolSearchResultBlock:
List<BetaToolReferenceBlock> toolReferences
JsonValue; type "tool_reference"constant"tool_reference"constant
JsonValue; type "tool_search_tool_search_result"constant"tool_search_tool_search_result"constant
JsonValue; type "tool_search_tool_result"constant"tool_search_tool_result"constant
class BetaMcpToolUseBlock:
String name
The name of the MCP tool
String serverName
The name of the MCP server
JsonValue; type "mcp_tool_use"constant"mcp_tool_use"constant
class BetaMcpToolResultBlock:
Content content
List<BetaTextBlock>
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class BetaCitationCharLocation:
JsonValue; type "char_location"constant"char_location"constant
class BetaCitationPageLocation:
JsonValue; type "page_location"constant"page_location"constant
class BetaCitationContentBlockLocation:
JsonValue; type "content_block_location"constant"content_block_location"constant
class BetaCitationsWebSearchResultLocation:
JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
class BetaCitationSearchResultLocation:
JsonValue; type "search_result_location"constant"search_result_location"constant
JsonValue; type "text"constant"text"constant
JsonValue; type "mcp_tool_result"constant"mcp_tool_result"constant
class BetaContainerUploadBlock:
Response model for a file uploaded to the container.
JsonValue; type "container_upload"constant"container_upload"constant
Context management response.
Information about context management strategies applied during the request.
List<AppliedEdit> appliedEdits
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse:
long clearedInputTokens
Number of input tokens cleared by this edit.
long clearedToolUses
Number of tool uses that were cleared.
JsonValue; type "clear_tool_uses_20250919"constant"clear_tool_uses_20250919"constant
The type of context management edit applied.
class BetaClearThinking20251015EditResponse:
long clearedInputTokens
Number of input tokens cleared by this edit.
long clearedThinkingTurns
Number of thinking turns that were cleared.
JsonValue; type "clear_thinking_20251015"constant"clear_thinking_20251015"constant
The type of context management edit applied.
Model model
The model that will complete your prompt.
See models for additional details and options.
CLAUDE_OPUS_4_5_20251101("claude-opus-4-5-20251101")
Premium model combining maximum intelligence with practical performance
CLAUDE_OPUS_4_5("claude-opus-4-5")
Premium model combining maximum intelligence with practical performance
CLAUDE_3_7_SONNET_LATEST("claude-3-7-sonnet-latest")
High-performance model with early extended thinking
CLAUDE_3_7_SONNET_20250219("claude-3-7-sonnet-20250219")
High-performance model with early extended thinking
CLAUDE_3_5_HAIKU_LATEST("claude-3-5-haiku-latest")
Fastest and most compact model for near-instant responsiveness
CLAUDE_3_5_HAIKU_20241022("claude-3-5-haiku-20241022")
Our fastest model
CLAUDE_HAIKU_4_5("claude-haiku-4-5")
Hybrid model, capable of near-instant responses and extended thinking
CLAUDE_HAIKU_4_5_20251001("claude-haiku-4-5-20251001")
Hybrid model, capable of near-instant responses and extended thinking
CLAUDE_SONNET_4_20250514("claude-sonnet-4-20250514")
High-performance model with extended thinking
CLAUDE_SONNET_4_0("claude-sonnet-4-0")
High-performance model with extended thinking
CLAUDE_4_SONNET_20250514("claude-4-sonnet-20250514")
High-performance model with extended thinking
CLAUDE_SONNET_4_5("claude-sonnet-4-5")
Our best model for real-world agents and coding
CLAUDE_SONNET_4_5_20250929("claude-sonnet-4-5-20250929")
Our best model for real-world agents and coding
CLAUDE_OPUS_4_0("claude-opus-4-0")
Our most capable model
CLAUDE_OPUS_4_20250514("claude-opus-4-20250514")
Our most capable model
CLAUDE_4_OPUS_20250514("claude-4-opus-20250514")
Our most capable model
CLAUDE_OPUS_4_1_20250805("claude-opus-4-1-20250805")
Our most capable model
CLAUDE_3_OPUS_LATEST("claude-3-opus-latest")
Excels at writing and complex tasks
CLAUDE_3_OPUS_20240229("claude-3-opus-20240229")
Excels at writing and complex tasks
CLAUDE_3_HAIKU_20240307("claude-3-haiku-20240307")
Our previous most fast and cost-effective
JsonValue; role "assistant"constant"assistant"constant
Conversational role of the generated message.
This will always be "assistant".
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
Optional<String> stopSequence
Which custom stop sequence was generated, if any.
This value will be a non-null string if one of your custom stop sequences was generated.
JsonValue; type "message"constant"message"constant
Object type.
For Messages, this is always "message".
BetaUsage 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.
Breakdown of cached tokens by TTL
long ephemeral1hInputTokens
The number of input tokens used to create the 1 hour cache entry.
long ephemeral5mInputTokens
The number of input tokens used to create the 5 minute cache entry.
Optional<Long> cacheCreationInputTokens
The number of input tokens used to create the cache entry.
Optional<Long> cacheReadInputTokens
The number of input tokens read from the cache.
long inputTokens
The number of input tokens which were used.
long outputTokens
The number of output tokens which were used.
The number of server tool requests.
long webFetchRequests
The number of web fetch tool requests.
long webSearchRequests
The number of web search tool requests.
Optional<ServiceTier> serviceTier
If the request used the priority, standard, or batch tier.
JsonValue; type "succeeded"constant"succeeded"constant
BetaFiles
Upload File
List Files
Download File
Get File Metadata
Delete File
ModelsExpand Collapse
class DeletedFile:
String id
ID of the deleted file.
Optional<Type> type
Deleted object type.
For file deletion, this is always "file_deleted".
class FileMetadata:
String id
Unique object identifier.
The format and length of IDs may change over time.
LocalDateTime createdAt
RFC 3339 datetime string representing when the file was created.
String filename
Original filename of the uploaded file.
String mimeType
MIME type of the file.
long sizeBytes
Size of the file in bytes.
JsonValue; type "file"constant"file"constant
Object type.
For files, this is always "file".
Optional<Boolean> downloadable
Whether the file can be downloaded.