Beta

String fileId

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

long returnCode

String stderr

String stdout

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

class BetaCodeExecutionTool20250522:

JsonValue; name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

Accepts one of the following:

CODE_EXECUTION("code_execution")

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_20250522("code_execution_20250522")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaCodeExecutionTool20250825:

JsonValue; name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

Accepts one of the following:

CODE_EXECUTION("code_execution")

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_20250825("code_execution_20250825")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaCodeExecutionToolResultBlock:

Accepts one of the following:

class BetaCodeExecutionToolResultError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlock:

List<BetaCodeExecutionOutputBlock> content

String fileId

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

long returnCode

String stderr

String stdout

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

String toolUseId

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT("code_execution_tool_result")

class BetaCodeExecutionToolResultBlockContent:

class BetaCodeExecutionToolResultError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlock:

List<BetaCodeExecutionOutputBlock> content

String fileId

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

long returnCode

String stderr

String stdout

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

class BetaCodeExecutionToolResultBlockParam:

BetaCodeExecutionToolResultBlockParamContent content

Accepts one of the following:

class BetaCodeExecutionToolResultErrorParam:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlockParam:

String fileId

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

long returnCode

String stderr

String stdout

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

String toolUseId

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT("code_execution_tool_result")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaCodeExecutionToolResultBlockParamContent:

class BetaCodeExecutionToolResultErrorParam:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlockParam:

String fileId

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

long returnCode

String stderr

String stdout

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

class BetaCodeExecutionToolResultError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

enum BetaCodeExecutionToolResultErrorCode:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

class BetaCodeExecutionToolResultErrorParam:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

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.

formatdate-time

Optional<List<BetaSkill>> skills

Skills loaded in the container

String skillId

Skill ID

maxLength64

minLength1

Type type

Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)

Accepts one of the following:

ANTHROPIC("anthropic")

CUSTOM("custom")

String version

Skill version or 'latest' for most recent version

maxLength64

minLength1

class BetaContainerParams:

Container parameters with skills to be loaded.

Optional<String> id

Container id

Optional<List<BetaSkillParams>> skills

List of skills to load in the container

String skillId

Skill ID

maxLength64

minLength1

Type type

Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)

Accepts one of the following:

ANTHROPIC("anthropic")

CUSTOM("custom")

Optional<String> version

Skill version or 'latest' for most recent version

maxLength64

minLength1

class BetaContainerUploadBlock:

Response model for a file uploaded to the container.

String fileId

JsonValue; type

Accepts one of the following:

CONTAINER_UPLOAD("container_upload")

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.

String fileId

JsonValue; type

Accepts one of the following:

CONTAINER_UPLOAD("container_upload")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaContentBlock:

Response model for a file uploaded to the container.

class BetaTextBlock:

Optional<List<BetaTextCitation>> citations

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.

Accepts one of the following:

class BetaCitationCharLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endCharIndex

Optional<String> fileId

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endPageNumber

Optional<String> fileId

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endBlockIndex

Optional<String> fileId

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

class BetaCitationSearchResultLocation:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

String text

maxLength5000000

minLength0

JsonValue; type

Accepts one of the following:

TEXT("text")

class BetaThinkingBlock:

String signature

String thinking

JsonValue; type

Accepts one of the following:

THINKING("thinking")

class BetaRedactedThinkingBlock:

String data

JsonValue; type

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaToolUseBlock:

String id

Input input

String name

minLength1

JsonValue; type

Accepts one of the following:

TOOL_USE("tool_use")

class BetaServerToolUseBlock:

String id

Input input

Name name

Accepts one of the following:

WEB_SEARCH("web_search")

WEB_FETCH("web_fetch")

CODE_EXECUTION("code_execution")

BASH_CODE_EXECUTION("bash_code_execution")

TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")

JsonValue; type

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

class BetaWebSearchToolResultBlock:

Accepts one of the following:

class BetaWebSearchToolResultError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

MAX_USES_EXCEEDED("max_uses_exceeded")

TOO_MANY_REQUESTS("too_many_requests")

QUERY_TOO_LONG("query_too_long")

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

String encryptedContent

Optional<String> pageAge

String title

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

String url

String toolUseId

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT("web_search_tool_result")

class BetaWebFetchToolResultBlock:

Content content

Accepts one of the following:

class BetaWebFetchToolResultErrorBlock:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

URL_TOO_LONG("url_too_long")

URL_NOT_ALLOWED("url_not_allowed")

URL_NOT_ACCESSIBLE("url_not_accessible")

UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")

TOO_MANY_REQUESTS("too_many_requests")

MAX_USES_EXCEEDED("max_uses_exceeded")

UNAVAILABLE("unavailable")

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

class BetaWebFetchBlock:

BetaDocumentBlock content

Optional<BetaCitationConfig> citations

Citation configuration for the document

boolean enabled

Source source

Accepts one of the following:

class BetaBase64PdfSource:

String data

formatbyte

JsonValue; mediaType

Accepts one of the following:

APPLICATION_PDF("application/pdf")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

String data

JsonValue; mediaType

Accepts one of the following:

TEXT_PLAIN("text/plain")

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<String> title

The title of the document

JsonValue; type

Accepts one of the following:

DOCUMENT("document")

Optional<String> retrievedAt

ISO 8601 timestamp when the content was retrieved

JsonValue; type

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

String url

Fetched content URL

String toolUseId

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT("web_fetch_tool_result")

class BetaCodeExecutionToolResultBlock:

Accepts one of the following:

class BetaCodeExecutionToolResultError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlock:

List<BetaCodeExecutionOutputBlock> content

String fileId

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

long returnCode

String stderr

String stdout

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

String toolUseId

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT("code_execution_tool_result")

class BetaBashCodeExecutionToolResultBlock:

Content content

Accepts one of the following:

class BetaBashCodeExecutionToolResultError:

ErrorCode errorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

OUTPUT_FILE_TOO_LARGE("output_file_too_large")

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")

class BetaBashCodeExecutionResultBlock:

List<BetaBashCodeExecutionOutputBlock> content

String fileId

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")

long returnCode

String stderr

String stdout

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")

String toolUseId

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT("bash_code_execution_tool_result")

class BetaTextEditorCodeExecutionToolResultBlock:

Content content

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultError:

ErrorCode errorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

FILE_NOT_FOUND("file_not_found")

Optional<String> errorMessage

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

class BetaTextEditorCodeExecutionViewResultBlock:

String content

FileType fileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

Optional<Long> numLines

Optional<Long> startLine

Optional<Long> totalLines

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

class BetaTextEditorCodeExecutionCreateResultBlock:

boolean isFileUpdate

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlock:

Optional<List<String>> lines

Optional<Long> newLines

Optional<Long> newStart

Optional<Long> oldLines

Optional<Long> oldStart

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

String toolUseId

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")

class BetaMcpToolUseBlock:

String id

Input input

String name

The name of the MCP tool

String serverName

The name of the MCP server

JsonValue; type

Accepts one of the following:

MCP_TOOL_USE("mcp_tool_use")

class BetaMcpToolResultBlock:

Content content

Accepts one of the following:

String

List<BetaTextBlock>

Optional<List<BetaTextCitation>> citations

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endCharIndex

Optional<String> fileId

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endPageNumber

Optional<String> fileId

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endBlockIndex

Optional<String> fileId

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

class BetaCitationSearchResultLocation:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

String text

maxLength5000000

minLength0

JsonValue; type

Accepts one of the following:

TEXT("text")

boolean isError

String toolUseId

JsonValue; type

Accepts one of the following:

MCP_TOOL_RESULT("mcp_tool_result")

class BetaContainerUploadBlock:

Response model for a file uploaded to the container.

String fileId

JsonValue; type

Accepts one of the following:

CONTAINER_UPLOAD("container_upload")

class BetaContentBlockParam:

Regular text content.

class BetaTextBlockParam:

String text

minLength1

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<List<BetaTextCitationParam>> citations

Accepts one of the following:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

Source source

Accepts one of the following:

class BetaBase64ImageSource:

String data

formatbyte

MediaType mediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileImageSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

IMAGE("image")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaRequestDocumentBlock:

Source source

Accepts one of the following:

class BetaBase64PdfSource:

String data

formatbyte

JsonValue; mediaType

Accepts one of the following:

APPLICATION_PDF("application/pdf")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

String data

JsonValue; mediaType

Accepts one of the following:

TEXT_PLAIN("text/plain")

JsonValue; type

Accepts one of the following:

TEXT("text")

class BetaContentBlockSource:

Content content

Accepts one of the following:

String

Accepts one of the following:

class BetaTextBlockParam:

String text

minLength1

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<List<BetaTextCitationParam>> citations

Accepts one of the following:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

Source source

Accepts one of the following:

class BetaBase64ImageSource:

String data

formatbyte

MediaType mediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileImageSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

IMAGE("image")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

JsonValue; type

Accepts one of the following:

CONTENT("content")

class BetaUrlPdfSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileDocumentSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

DOCUMENT("document")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<BetaCitationsConfigParam> citations

Optional<Boolean> enabled

Optional<String> context

minLength1

Optional<String> title

maxLength500

minLength1

class BetaSearchResultBlockParam:

List<BetaTextBlockParam> content

String text

minLength1

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<List<BetaTextCitationParam>> citations

Accepts one of the following:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

String source

String title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT("search_result")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<BetaCitationsConfigParam> citations

Optional<Boolean> enabled

class BetaThinkingBlockParam:

String signature

String thinking

JsonValue; type

Accepts one of the following:

THINKING("thinking")

class BetaRedactedThinkingBlockParam:

String data

JsonValue; type

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaToolUseBlockParam:

String id

Input input

String name

maxLength200

minLength1

JsonValue; type

Accepts one of the following:

TOOL_USE("tool_use")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaToolResultBlockParam:

String toolUseId

JsonValue; type

Accepts one of the following:

TOOL_RESULT("tool_result")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<Content> content

Accepts one of the following:

String

List<Block>

Accepts one of the following:

class BetaTextBlockParam:

String text

minLength1

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<List<BetaTextCitationParam>> citations

Accepts one of the following:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

Source source

Accepts one of the following:

class BetaBase64ImageSource:

String data

formatbyte

MediaType mediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileImageSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

IMAGE("image")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaSearchResultBlockParam:

List<BetaTextBlockParam> content

String text

minLength1

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<List<BetaTextCitationParam>> citations

Accepts one of the following:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

String source

String title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT("search_result")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<BetaCitationsConfigParam> citations

Optional<Boolean> enabled

class BetaRequestDocumentBlock:

Source source

Accepts one of the following:

class BetaBase64PdfSource:

String data

formatbyte

JsonValue; mediaType

Accepts one of the following:

APPLICATION_PDF("application/pdf")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

String data

JsonValue; mediaType

Accepts one of the following:

TEXT_PLAIN("text/plain")

JsonValue; type

Accepts one of the following:

TEXT("text")

class BetaContentBlockSource:

Content content

Accepts one of the following:

String

Accepts one of the following:

class BetaTextBlockParam:

String text

minLength1

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<List<BetaTextCitationParam>> citations

Accepts one of the following:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

Source source

Accepts one of the following:

class BetaBase64ImageSource:

String data

formatbyte

MediaType mediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileImageSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

IMAGE("image")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

JsonValue; type

Accepts one of the following:

CONTENT("content")

class BetaUrlPdfSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileDocumentSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

DOCUMENT("document")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<BetaCitationsConfigParam> citations

Optional<Boolean> enabled

Optional<String> context

minLength1

Optional<String> title

maxLength500

minLength1

Optional<Boolean> isError

class BetaServerToolUseBlockParam:

String id

Input input

Name name

Accepts one of the following:

WEB_SEARCH("web_search")

WEB_FETCH("web_fetch")

CODE_EXECUTION("code_execution")

BASH_CODE_EXECUTION("bash_code_execution")

TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")

JsonValue; type

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaWebSearchToolResultBlockParam:

BetaWebSearchToolResultBlockParamContent content

Accepts one of the following:

String encryptedContent

String title

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

String url

Optional<String> pageAge

class BetaWebSearchToolRequestError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

MAX_USES_EXCEEDED("max_uses_exceeded")

TOO_MANY_REQUESTS("too_many_requests")

QUERY_TOO_LONG("query_too_long")

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

String toolUseId

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT("web_search_tool_result")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaWebFetchToolResultBlockParam:

Content content

Accepts one of the following:

class BetaWebFetchToolResultErrorBlockParam:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

URL_TOO_LONG("url_too_long")

URL_NOT_ALLOWED("url_not_allowed")

URL_NOT_ACCESSIBLE("url_not_accessible")

UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")

TOO_MANY_REQUESTS("too_many_requests")

MAX_USES_EXCEEDED("max_uses_exceeded")

UNAVAILABLE("unavailable")

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

class BetaWebFetchBlockParam:

Source source

Accepts one of the following:

class BetaBase64PdfSource:

String data

formatbyte

JsonValue; mediaType

Accepts one of the following:

APPLICATION_PDF("application/pdf")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

String data

JsonValue; mediaType

Accepts one of the following:

TEXT_PLAIN("text/plain")

JsonValue; type

Accepts one of the following:

TEXT("text")

class BetaContentBlockSource:

Content content

Accepts one of the following:

String

Accepts one of the following:

class BetaTextBlockParam:

String text

minLength1

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<List<BetaTextCitationParam>> citations

Accepts one of the following:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

Source source

Accepts one of the following:

class BetaBase64ImageSource:

String data

formatbyte

MediaType mediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileImageSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

IMAGE("image")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

JsonValue; type

Accepts one of the following:

CONTENT("content")

class BetaUrlPdfSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileDocumentSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

DOCUMENT("document")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<BetaCitationsConfigParam> citations

Optional<Boolean> enabled

Optional<String> context

minLength1

Optional<String> title

maxLength500

minLength1

JsonValue; type

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

String url

Fetched content URL

Optional<String> retrievedAt

ISO 8601 timestamp when the content was retrieved

String toolUseId

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT("web_fetch_tool_result")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaCodeExecutionToolResultBlockParam:

BetaCodeExecutionToolResultBlockParamContent content

Accepts one of the following:

class BetaCodeExecutionToolResultErrorParam:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlockParam:

String fileId

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

long returnCode

String stderr

String stdout

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

String toolUseId

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT("code_execution_tool_result")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaBashCodeExecutionToolResultBlockParam:

Content content

Accepts one of the following:

class BetaBashCodeExecutionToolResultErrorParam:

ErrorCode errorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

OUTPUT_FILE_TOO_LARGE("output_file_too_large")

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")

class BetaBashCodeExecutionResultBlockParam:

List<BetaBashCodeExecutionOutputBlockParam> content

String fileId

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")

long returnCode

String stderr

String stdout

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")

String toolUseId

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT("bash_code_execution_tool_result")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaTextEditorCodeExecutionToolResultBlockParam:

Content content

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultErrorParam:

ErrorCode errorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

FILE_NOT_FOUND("file_not_found")

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

Optional<String> errorMessage

class BetaTextEditorCodeExecutionViewResultBlockParam:

String content

FileType fileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

Optional<Long> numLines

Optional<Long> startLine

Optional<Long> totalLines

class BetaTextEditorCodeExecutionCreateResultBlockParam:

boolean isFileUpdate

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlockParam:

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

Optional<List<String>> lines

Optional<Long> newLines

Optional<Long> newStart

Optional<Long> oldLines

Optional<Long> oldStart

String toolUseId

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaMcpToolUseBlockParam:

String id

Input input

String name

String serverName

The name of the MCP server

JsonValue; type

Accepts one of the following:

MCP_TOOL_USE("mcp_tool_use")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaRequestMcpToolResultBlockParam:

String toolUseId

JsonValue; type

Accepts one of the following:

MCP_TOOL_RESULT("mcp_tool_result")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<Content> content

Accepts one of the following:

String

List<BetaTextBlockParam>

String text

minLength1

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<List<BetaTextCitationParam>> citations

Accepts one of the following:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

Optional<Boolean> isError

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.

String fileId

JsonValue; type

Accepts one of the following:

CONTAINER_UPLOAD("container_upload")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaContentBlockSource:

Content content

Accepts one of the following:

String

Accepts one of the following:

class BetaTextBlockParam:

String text

minLength1

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<List<BetaTextCitationParam>> citations

Accepts one of the following:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

Source source

Accepts one of the following:

class BetaBase64ImageSource:

String data

formatbyte

MediaType mediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileImageSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

IMAGE("image")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

JsonValue; type

Accepts one of the following:

CONTENT("content")

class BetaContentBlockSourceContent:

class BetaTextBlockParam:

String text

minLength1

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<List<BetaTextCitationParam>> citations

Accepts one of the following:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

Source source

Accepts one of the following:

class BetaBase64ImageSource:

String data

formatbyte

MediaType mediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileImageSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

IMAGE("image")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaContextManagementConfig:

Optional<List<Edit>> edits

List of context management edits to apply

Accepts one of the following:

class BetaClearToolUses20250919Edit:

JsonValue; type

Accepts one of the following:

CLEAR_TOOL_USES_20250919("clear_tool_uses_20250919")

Optional<BetaInputTokensClearAtLeast> clearAtLeast

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

Accepts one of the following:

INPUT_TOKENS("input_tokens")

long value

minimum0

Optional<ClearToolInputs> clearToolInputs

Whether to clear all tool inputs (bool) or specific tool inputs to clear (list)

Accepts one of the following:

boolean

List<String>

Optional<List<String>> excludeTools

Tool names whose uses are preserved from clearing

Optional<BetaToolUsesKeep> keep

Number of tool uses to retain in the conversation

JsonValue; type

Accepts one of the following:

TOOL_USES("tool_uses")

long value

minimum0

Optional<Trigger> trigger

Condition that triggers the context management strategy

Accepts one of the following:

class BetaInputTokensTrigger:

JsonValue; type

Accepts one of the following:

INPUT_TOKENS("input_tokens")

long value

minimum1

class BetaToolUsesTrigger:

JsonValue; type

Accepts one of the following:

TOOL_USES("tool_uses")

long value

minimum1

class BetaClearThinking20251015Edit:

JsonValue; type

Accepts one of the following:

CLEAR_THINKING_20251015("clear_thinking_20251015")

Optional<Keep> keep

Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed.

Accepts one of the following:

class BetaThinkingTurns:

JsonValue; type

Accepts one of the following:

THINKING_TURNS("thinking_turns")

long value

minimum1

class BetaAllThinkingTurns:

JsonValue; type

Accepts one of the following:

ALL("all")

JsonValue;

Accepts one of the following:

ALL("all")

class BetaContextManagementResponse:

List<AppliedEdit> appliedEdits

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse:

long clearedInputTokens

Number of input tokens cleared by this edit.

minimum0

long clearedToolUses

Number of tool uses that were cleared.

minimum0

JsonValue; type

The type of context management edit applied.

Accepts one of the following:

CLEAR_TOOL_USES_20250919("clear_tool_uses_20250919")

class BetaClearThinking20251015EditResponse:

long clearedInputTokens

Number of input tokens cleared by this edit.

minimum0

long clearedThinkingTurns

Number of thinking turns that were cleared.

minimum0

JsonValue; type

The type of context management edit applied.

Accepts one of the following:

CLEAR_THINKING_20251015("clear_thinking_20251015")

class BetaCountTokensContextManagementResponse:

long originalInputTokens

The original token count before context management was applied

class BetaDocumentBlock:

Optional<BetaCitationConfig> citations

Citation configuration for the document

boolean enabled

Source source

Accepts one of the following:

class BetaBase64PdfSource:

String data

formatbyte

JsonValue; mediaType

Accepts one of the following:

APPLICATION_PDF("application/pdf")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

String data

JsonValue; mediaType

Accepts one of the following:

TEXT_PLAIN("text/plain")

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<String> title

The title of the document

JsonValue; type

Accepts one of the following:

DOCUMENT("document")

class BetaFileDocumentSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

class BetaFileImageSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

class BetaImageBlockParam:

Source source

Accepts one of the following:

class BetaBase64ImageSource:

String data

formatbyte

MediaType mediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileImageSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

IMAGE("image")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaInputJsonDelta:

String partialJson

JsonValue; type

Accepts one of the following:

INPUT_JSON_DELTA("input_json_delta")

class BetaInputTokensClearAtLeast:

JsonValue; type

Accepts one of the following:

INPUT_TOKENS("input_tokens")

long value

minimum0

class BetaInputTokensTrigger:

JsonValue; type

Accepts one of the following:

INPUT_TOKENS("input_tokens")

long value

minimum1

class BetaMcpToolResultBlock:

Content content

Accepts one of the following:

String

List<BetaTextBlock>

Optional<List<BetaTextCitation>> citations

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endCharIndex

Optional<String> fileId

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endPageNumber

Optional<String> fileId

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endBlockIndex

Optional<String> fileId

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

class BetaCitationSearchResultLocation:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

String text

maxLength5000000

minLength0

JsonValue; type

Accepts one of the following:

TEXT("text")

boolean isError

String toolUseId

JsonValue; type

Accepts one of the following:

MCP_TOOL_RESULT("mcp_tool_result")

class BetaMcpToolUseBlock:

String id

Input input

String name

The name of the MCP tool

String serverName

The name of the MCP server

JsonValue; type

Accepts one of the following:

MCP_TOOL_USE("mcp_tool_use")

class BetaMcpToolUseBlockParam:

String id

Input input

String name

String serverName

The name of the MCP server

JsonValue; type

Accepts one of the following:

MCP_TOOL_USE("mcp_tool_use")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaMemoryTool20250818:

JsonValue; name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

Accepts one of the following:

MEMORY("memory")

JsonValue; type

Accepts one of the following:

MEMORY_20250818("memory_20250818")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaMemoryTool20250818Command:

class BetaMemoryTool20250818ViewCommand:

JsonValue; command

Command type identifier

Accepts one of the following:

VIEW("view")

String path

Path to directory or file to view

Optional<List<Long>> viewRange

Optional line range for viewing specific lines

class BetaMemoryTool20250818CreateCommand:

JsonValue; command

Command type identifier

Accepts one of the following:

CREATE("create")

String fileText

Content to write to the file

String path

Path where the file should be created

class BetaMemoryTool20250818StrReplaceCommand:

JsonValue; command

Command type identifier

Accepts one of the following:

STR_REPLACE("str_replace")

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

Command type identifier

Accepts one of the following:

INSERT("insert")

long insertLine

Line number where text should be inserted

minimum1

String insertText

Text to insert at the specified line

String path

Path to the file where text should be inserted

class BetaMemoryTool20250818DeleteCommand:

JsonValue; command

Command type identifier

Accepts one of the following:

DELETE("delete")

String path

Path to the file or directory to delete

class BetaMemoryTool20250818RenameCommand:

JsonValue; command

Command type identifier

Accepts one of the following:

RENAME("rename")

String newPath

New path for the file or directory

String oldPath

Current path of the file or directory

class BetaMemoryTool20250818CreateCommand:

JsonValue; command

Command type identifier

Accepts one of the following:

CREATE("create")

String fileText

Content to write to the file

String path

Path where the file should be created

class BetaMemoryTool20250818DeleteCommand:

JsonValue; command

Command type identifier

Accepts one of the following:

DELETE("delete")

String path

Path to the file or directory to delete

class BetaMemoryTool20250818InsertCommand:

JsonValue; command

Command type identifier

Accepts one of the following:

INSERT("insert")

long insertLine

Line number where text should be inserted

minimum1

String insertText

Text to insert at the specified line

String path

Path to the file where text should be inserted

class BetaMemoryTool20250818RenameCommand:

JsonValue; command

Command type identifier

Accepts one of the following:

RENAME("rename")

String newPath

New path for the file or directory

String oldPath

Current path of the file or directory

class BetaMemoryTool20250818StrReplaceCommand:

JsonValue; command

Command type identifier

Accepts one of the following:

STR_REPLACE("str_replace")

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

Command type identifier

Accepts one of the following:

VIEW("view")

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.

Optional<BetaContainer> container

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.

formatdate-time

Optional<List<BetaSkill>> skills

Skills loaded in the container

String skillId

Skill ID

maxLength64

minLength1

Type type

Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)

Accepts one of the following:

ANTHROPIC("anthropic")

CUSTOM("custom")

String version

Skill version or 'latest' for most recent version

maxLength64

minLength1

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)"}]

Accepts one of the following:

class BetaTextBlock:

Optional<List<BetaTextCitation>> citations

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endCharIndex

Optional<String> fileId

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endPageNumber

Optional<String> fileId

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endBlockIndex

Optional<String> fileId

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

class BetaCitationSearchResultLocation:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

String text

maxLength5000000

minLength0

JsonValue; type

Accepts one of the following:

TEXT("text")

class BetaThinkingBlock:

String signature

String thinking

JsonValue; type

Accepts one of the following:

THINKING("thinking")

class BetaRedactedThinkingBlock:

String data

JsonValue; type

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaToolUseBlock:

String id

Input input

String name

minLength1

JsonValue; type

Accepts one of the following:

TOOL_USE("tool_use")

class BetaServerToolUseBlock:

String id

Input input

Name name

Accepts one of the following:

WEB_SEARCH("web_search")

WEB_FETCH("web_fetch")

CODE_EXECUTION("code_execution")

BASH_CODE_EXECUTION("bash_code_execution")

TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")

JsonValue; type

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

class BetaWebSearchToolResultBlock:

Accepts one of the following:

class BetaWebSearchToolResultError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

MAX_USES_EXCEEDED("max_uses_exceeded")

TOO_MANY_REQUESTS("too_many_requests")

QUERY_TOO_LONG("query_too_long")

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

String encryptedContent

Optional<String> pageAge

String title

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

String url

String toolUseId

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT("web_search_tool_result")

class BetaWebFetchToolResultBlock:

Content content

Accepts one of the following:

class BetaWebFetchToolResultErrorBlock:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

URL_TOO_LONG("url_too_long")

URL_NOT_ALLOWED("url_not_allowed")

URL_NOT_ACCESSIBLE("url_not_accessible")

UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")

TOO_MANY_REQUESTS("too_many_requests")

MAX_USES_EXCEEDED("max_uses_exceeded")

UNAVAILABLE("unavailable")

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

class BetaWebFetchBlock:

BetaDocumentBlock content

Optional<BetaCitationConfig> citations

Citation configuration for the document

boolean enabled

Source source

Accepts one of the following:

class BetaBase64PdfSource:

String data

formatbyte

JsonValue; mediaType

Accepts one of the following:

APPLICATION_PDF("application/pdf")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

String data

JsonValue; mediaType

Accepts one of the following:

TEXT_PLAIN("text/plain")

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<String> title

The title of the document

JsonValue; type

Accepts one of the following:

DOCUMENT("document")

Optional<String> retrievedAt

ISO 8601 timestamp when the content was retrieved

JsonValue; type

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

String url

Fetched content URL

String toolUseId

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT("web_fetch_tool_result")

class BetaCodeExecutionToolResultBlock:

Accepts one of the following:

class BetaCodeExecutionToolResultError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlock:

List<BetaCodeExecutionOutputBlock> content

String fileId

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

long returnCode

String stderr

String stdout

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

String toolUseId

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT("code_execution_tool_result")

class BetaBashCodeExecutionToolResultBlock:

Content content

Accepts one of the following:

class BetaBashCodeExecutionToolResultError:

ErrorCode errorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

OUTPUT_FILE_TOO_LARGE("output_file_too_large")

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")

class BetaBashCodeExecutionResultBlock:

List<BetaBashCodeExecutionOutputBlock> content

String fileId

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")

long returnCode

String stderr

String stdout

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")

String toolUseId

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT("bash_code_execution_tool_result")

class BetaTextEditorCodeExecutionToolResultBlock:

Content content

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultError:

ErrorCode errorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

FILE_NOT_FOUND("file_not_found")

Optional<String> errorMessage

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

class BetaTextEditorCodeExecutionViewResultBlock:

String content

FileType fileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

Optional<Long> numLines

Optional<Long> startLine

Optional<Long> totalLines

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

class BetaTextEditorCodeExecutionCreateResultBlock:

boolean isFileUpdate

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlock:

Optional<List<String>> lines

Optional<Long> newLines

Optional<Long> newStart

Optional<Long> oldLines

Optional<Long> oldStart

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

String toolUseId

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")

class BetaMcpToolUseBlock:

String id

Input input

String name

The name of the MCP tool

String serverName

The name of the MCP server

JsonValue; type

Accepts one of the following:

MCP_TOOL_USE("mcp_tool_use")

class BetaMcpToolResultBlock:

Content content

Accepts one of the following:

String

List<BetaTextBlock>

Optional<List<BetaTextCitation>> citations

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endCharIndex

Optional<String> fileId

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endPageNumber

Optional<String> fileId

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endBlockIndex

Optional<String> fileId

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

class BetaCitationSearchResultLocation:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

String text

maxLength5000000

minLength0

JsonValue; type

Accepts one of the following:

TEXT("text")

boolean isError

String toolUseId

JsonValue; type

Accepts one of the following:

MCP_TOOL_RESULT("mcp_tool_result")

class BetaContainerUploadBlock:

Response model for a file uploaded to the container.

String fileId

JsonValue; type

Accepts one of the following:

CONTAINER_UPLOAD("container_upload")

Optional<BetaContextManagementResponse> contextManagement

Context management response.

Information about context management strategies applied during the request.

List<AppliedEdit> appliedEdits

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse:

long clearedInputTokens

Number of input tokens cleared by this edit.

minimum0

long clearedToolUses

Number of tool uses that were cleared.

minimum0

JsonValue; type

The type of context management edit applied.

Accepts one of the following:

CLEAR_TOOL_USES_20250919("clear_tool_uses_20250919")

class BetaClearThinking20251015EditResponse:

long clearedInputTokens

Number of input tokens cleared by this edit.

minimum0

long clearedThinkingTurns

Number of thinking turns that were cleared.

minimum0

JsonValue; type

The type of context management edit applied.

Accepts one of the following:

CLEAR_THINKING_20251015("clear_thinking_20251015")

Model model

The model that will complete your prompt.

See models for additional details and options.

Accepts one of the following:

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

Conversational role of the generated message.

This will always be "assistant".

Accepts one of the following:

ASSISTANT("assistant")

Optional<BetaStopReason> stopReason

The reason that we stopped.

This may be one the following values:

"end_turn": the model reached a natural stopping point
"max_tokens": we exceeded the requested max_tokens or the model's maximum
"stop_sequence": one of your provided custom stop_sequences was generated
"tool_use": the model invoked one or more tools
"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue.
"refusal": when streaming classifiers intervene to handle potential policy violations

In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.

Accepts one of the following:

END_TURN("end_turn")

MAX_TOKENS("max_tokens")

STOP_SEQUENCE("stop_sequence")

TOOL_USE("tool_use")

PAUSE_TURN("pause_turn")

REFUSAL("refusal")

MODEL_CONTEXT_WINDOW_EXCEEDED("model_context_window_exceeded")

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

Object type.

For Messages, this is always "message".

Accepts one of the following:

MESSAGE("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.

Optional<BetaCacheCreation> cacheCreation

Breakdown of cached tokens by TTL

long ephemeral1hInputTokens

The number of input tokens used to create the 1 hour cache entry.

minimum0

long ephemeral5mInputTokens

The number of input tokens used to create the 5 minute cache entry.

minimum0

Optional<Long> cacheCreationInputTokens

The number of input tokens used to create the cache entry.

minimum0

Optional<Long> cacheReadInputTokens

The number of input tokens read from the cache.

minimum0

long inputTokens

The number of input tokens which were used.

minimum0

long outputTokens

The number of output tokens which were used.

minimum0

Optional<BetaServerToolUsage> serverToolUse

The number of server tool requests.

long webFetchRequests

The number of web fetch tool requests.

minimum0

long webSearchRequests

The number of web search tool requests.

minimum0

Optional<ServiceTier> serviceTier

If the request used the priority, standard, or batch tier.

Accepts one of the following:

STANDARD("standard")

PRIORITY("priority")

BATCH("batch")

class BetaMessageDeltaUsage:

Optional<Long> cacheCreationInputTokens

The cumulative number of input tokens used to create the cache entry.

minimum0

Optional<Long> cacheReadInputTokens

The cumulative number of input tokens read from the cache.

minimum0

Optional<Long> inputTokens

The cumulative number of input tokens which were used.

minimum0

long outputTokens

The cumulative number of output tokens which were used.

Optional<BetaServerToolUsage> serverToolUse

The number of server tool requests.

long webFetchRequests

The number of web fetch tool requests.

minimum0

long webSearchRequests

The number of web search tool requests.

minimum0

class BetaMessageParam:

Content content

Accepts one of the following:

String

List<BetaContentBlockParam>

Accepts one of the following:

class BetaTextBlockParam:

String text

minLength1

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<List<BetaTextCitationParam>> citations

Accepts one of the following:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

Source source

Accepts one of the following:

class BetaBase64ImageSource:

String data

formatbyte

MediaType mediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileImageSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

IMAGE("image")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaRequestDocumentBlock:

Source source

Accepts one of the following:

class BetaBase64PdfSource:

String data

formatbyte

JsonValue; mediaType

Accepts one of the following:

APPLICATION_PDF("application/pdf")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

String data

JsonValue; mediaType

Accepts one of the following:

TEXT_PLAIN("text/plain")

JsonValue; type

Accepts one of the following:

TEXT("text")

class BetaContentBlockSource:

Content content

Accepts one of the following:

String

Accepts one of the following:

class BetaTextBlockParam:

String text

minLength1

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<List<BetaTextCitationParam>> citations

Accepts one of the following:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

Source source

Accepts one of the following:

class BetaBase64ImageSource:

String data

formatbyte

MediaType mediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileImageSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

IMAGE("image")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

JsonValue; type

Accepts one of the following:

CONTENT("content")

class BetaUrlPdfSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileDocumentSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

DOCUMENT("document")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<BetaCitationsConfigParam> citations

Optional<Boolean> enabled

Optional<String> context

minLength1

Optional<String> title

maxLength500

minLength1

class BetaSearchResultBlockParam:

List<BetaTextBlockParam> content

String text

minLength1

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<List<BetaTextCitationParam>> citations

Accepts one of the following:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

String source

String title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT("search_result")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<BetaCitationsConfigParam> citations

Optional<Boolean> enabled

class BetaThinkingBlockParam:

String signature

String thinking

JsonValue; type

Accepts one of the following:

THINKING("thinking")

class BetaRedactedThinkingBlockParam:

String data

JsonValue; type

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaToolUseBlockParam:

String id

Input input

String name

maxLength200

minLength1

JsonValue; type

Accepts one of the following:

TOOL_USE("tool_use")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaToolResultBlockParam:

String toolUseId

JsonValue; type

Accepts one of the following:

TOOL_RESULT("tool_result")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<Content> content

Accepts one of the following:

String

List<Block>

Accepts one of the following:

class BetaTextBlockParam:

String text

minLength1

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<List<BetaTextCitationParam>> citations

Accepts one of the following:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

Source source

Accepts one of the following:

class BetaBase64ImageSource:

String data

formatbyte

MediaType mediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileImageSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

IMAGE("image")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaSearchResultBlockParam:

List<BetaTextBlockParam> content

String text

minLength1

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<List<BetaTextCitationParam>> citations

Accepts one of the following:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

String source

String title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT("search_result")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<BetaCitationsConfigParam> citations

Optional<Boolean> enabled

class BetaRequestDocumentBlock:

Source source

Accepts one of the following:

class BetaBase64PdfSource:

String data

formatbyte

JsonValue; mediaType

Accepts one of the following:

APPLICATION_PDF("application/pdf")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

String data

JsonValue; mediaType

Accepts one of the following:

TEXT_PLAIN("text/plain")

JsonValue; type

Accepts one of the following:

TEXT("text")

class BetaContentBlockSource:

Content content

Accepts one of the following:

String

Accepts one of the following:

class BetaTextBlockParam:

String text

minLength1

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<List<BetaTextCitationParam>> citations

Accepts one of the following:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

Source source

Accepts one of the following:

class BetaBase64ImageSource:

String data

formatbyte

MediaType mediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileImageSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

IMAGE("image")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

JsonValue; type

Accepts one of the following:

CONTENT("content")

class BetaUrlPdfSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileDocumentSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

DOCUMENT("document")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<BetaCitationsConfigParam> citations

Optional<Boolean> enabled

Optional<String> context

minLength1

Optional<String> title

maxLength500

minLength1

Optional<Boolean> isError

class BetaServerToolUseBlockParam:

String id

Input input

Name name

Accepts one of the following:

WEB_SEARCH("web_search")

WEB_FETCH("web_fetch")

CODE_EXECUTION("code_execution")

BASH_CODE_EXECUTION("bash_code_execution")

TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")

JsonValue; type

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaWebSearchToolResultBlockParam:

BetaWebSearchToolResultBlockParamContent content

Accepts one of the following:

String encryptedContent

String title

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

String url

Optional<String> pageAge

class BetaWebSearchToolRequestError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

MAX_USES_EXCEEDED("max_uses_exceeded")

TOO_MANY_REQUESTS("too_many_requests")

QUERY_TOO_LONG("query_too_long")

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

String toolUseId

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT("web_search_tool_result")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaWebFetchToolResultBlockParam:

Content content

Accepts one of the following:

class BetaWebFetchToolResultErrorBlockParam:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

URL_TOO_LONG("url_too_long")

URL_NOT_ALLOWED("url_not_allowed")

URL_NOT_ACCESSIBLE("url_not_accessible")

UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")

TOO_MANY_REQUESTS("too_many_requests")

MAX_USES_EXCEEDED("max_uses_exceeded")

UNAVAILABLE("unavailable")

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

class BetaWebFetchBlockParam:

Source source

Accepts one of the following:

class BetaBase64PdfSource:

String data

formatbyte

JsonValue; mediaType

Accepts one of the following:

APPLICATION_PDF("application/pdf")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

String data

JsonValue; mediaType

Accepts one of the following:

TEXT_PLAIN("text/plain")

JsonValue; type

Accepts one of the following:

TEXT("text")

class BetaContentBlockSource:

Content content

Accepts one of the following:

String

Accepts one of the following:

class BetaTextBlockParam:

String text

minLength1

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<List<BetaTextCitationParam>> citations

Accepts one of the following:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

Source source

Accepts one of the following:

class BetaBase64ImageSource:

String data

formatbyte

MediaType mediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileImageSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

IMAGE("image")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

JsonValue; type

Accepts one of the following:

CONTENT("content")

class BetaUrlPdfSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileDocumentSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

DOCUMENT("document")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<BetaCitationsConfigParam> citations

Optional<Boolean> enabled

Optional<String> context

minLength1

Optional<String> title

maxLength500

minLength1

JsonValue; type

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

String url

Fetched content URL

Optional<String> retrievedAt

ISO 8601 timestamp when the content was retrieved

String toolUseId

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT("web_fetch_tool_result")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaCodeExecutionToolResultBlockParam:

BetaCodeExecutionToolResultBlockParamContent content

Accepts one of the following:

class BetaCodeExecutionToolResultErrorParam:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlockParam:

String fileId

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

long returnCode

String stderr

String stdout

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

String toolUseId

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT("code_execution_tool_result")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaBashCodeExecutionToolResultBlockParam:

Content content

Accepts one of the following:

class BetaBashCodeExecutionToolResultErrorParam:

ErrorCode errorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

OUTPUT_FILE_TOO_LARGE("output_file_too_large")

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")

class BetaBashCodeExecutionResultBlockParam:

List<BetaBashCodeExecutionOutputBlockParam> content

String fileId

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")

long returnCode

String stderr

String stdout

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")

String toolUseId

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT("bash_code_execution_tool_result")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaTextEditorCodeExecutionToolResultBlockParam:

Content content

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultErrorParam:

ErrorCode errorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

FILE_NOT_FOUND("file_not_found")

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

Optional<String> errorMessage

class BetaTextEditorCodeExecutionViewResultBlockParam:

String content

FileType fileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

Optional<Long> numLines

Optional<Long> startLine

Optional<Long> totalLines

class BetaTextEditorCodeExecutionCreateResultBlockParam:

boolean isFileUpdate

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlockParam:

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

Optional<List<String>> lines

Optional<Long> newLines

Optional<Long> newStart

Optional<Long> oldLines

Optional<Long> oldStart

String toolUseId

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaMcpToolUseBlockParam:

String id

Input input

String name

String serverName

The name of the MCP server

JsonValue; type

Accepts one of the following:

MCP_TOOL_USE("mcp_tool_use")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaRequestMcpToolResultBlockParam:

String toolUseId

JsonValue; type

Accepts one of the following:

MCP_TOOL_RESULT("mcp_tool_result")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<Content> content

Accepts one of the following:

String

List<BetaTextBlockParam>

String text

minLength1

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<List<BetaTextCitationParam>> citations

Accepts one of the following:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

Optional<Boolean> isError

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.

String fileId

JsonValue; type

Accepts one of the following:

CONTAINER_UPLOAD("container_upload")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Role role

Accepts one of the following:

USER("user")

ASSISTANT("assistant")

class BetaMessageTokensCount:

Optional<BetaCountTokensContextManagementResponse> contextManagement

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.

maxLength256

class BetaPlainTextSource:

String data

JsonValue; mediaType

Accepts one of the following:

TEXT_PLAIN("text/plain")

JsonValue; type

Accepts one of the following:

TEXT("text")

class BetaRawContentBlockDelta:

class BetaTextDelta:

String text

JsonValue; type

Accepts one of the following:

TEXT_DELTA("text_delta")

class BetaInputJsonDelta:

String partialJson

JsonValue; type

Accepts one of the following:

INPUT_JSON_DELTA("input_json_delta")

class BetaCitationsDelta:

Citation citation

Accepts one of the following:

class BetaCitationCharLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endCharIndex

Optional<String> fileId

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endPageNumber

Optional<String> fileId

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endBlockIndex

Optional<String> fileId

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

class BetaCitationSearchResultLocation:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

JsonValue; type

Accepts one of the following:

CITATIONS_DELTA("citations_delta")

class BetaThinkingDelta:

String thinking

JsonValue; type

Accepts one of the following:

THINKING_DELTA("thinking_delta")

class BetaSignatureDelta:

String signature

JsonValue; type

Accepts one of the following:

SIGNATURE_DELTA("signature_delta")

class BetaRawContentBlockDeltaEvent:

BetaRawContentBlockDelta delta

Accepts one of the following:

class BetaTextDelta:

String text

JsonValue; type

Accepts one of the following:

TEXT_DELTA("text_delta")

class BetaInputJsonDelta:

String partialJson

JsonValue; type

Accepts one of the following:

INPUT_JSON_DELTA("input_json_delta")

class BetaCitationsDelta:

Citation citation

Accepts one of the following:

class BetaCitationCharLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endCharIndex

Optional<String> fileId

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endPageNumber

Optional<String> fileId

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endBlockIndex

Optional<String> fileId

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

class BetaCitationSearchResultLocation:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

JsonValue; type

Accepts one of the following:

CITATIONS_DELTA("citations_delta")

class BetaThinkingDelta:

String thinking

JsonValue; type

Accepts one of the following:

THINKING_DELTA("thinking_delta")

class BetaSignatureDelta:

String signature

JsonValue; type

Accepts one of the following:

SIGNATURE_DELTA("signature_delta")

long index

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_DELTA("content_block_delta")

class BetaRawContentBlockStartEvent:

ContentBlock contentBlock

Response model for a file uploaded to the container.

Accepts one of the following:

class BetaTextBlock:

Optional<List<BetaTextCitation>> citations

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endCharIndex

Optional<String> fileId

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endPageNumber

Optional<String> fileId

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endBlockIndex

Optional<String> fileId

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

class BetaCitationSearchResultLocation:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

String text

maxLength5000000

minLength0

JsonValue; type

Accepts one of the following:

TEXT("text")

class BetaThinkingBlock:

String signature

String thinking

JsonValue; type

Accepts one of the following:

THINKING("thinking")

class BetaRedactedThinkingBlock:

String data

JsonValue; type

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaToolUseBlock:

String id

Input input

String name

minLength1

JsonValue; type

Accepts one of the following:

TOOL_USE("tool_use")

class BetaServerToolUseBlock:

String id

Input input

Name name

Accepts one of the following:

WEB_SEARCH("web_search")

WEB_FETCH("web_fetch")

CODE_EXECUTION("code_execution")

BASH_CODE_EXECUTION("bash_code_execution")

TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")

JsonValue; type

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

class BetaWebSearchToolResultBlock:

Accepts one of the following:

class BetaWebSearchToolResultError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

MAX_USES_EXCEEDED("max_uses_exceeded")

TOO_MANY_REQUESTS("too_many_requests")

QUERY_TOO_LONG("query_too_long")

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

String encryptedContent

Optional<String> pageAge

String title

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

String url

String toolUseId

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT("web_search_tool_result")

class BetaWebFetchToolResultBlock:

Content content

Accepts one of the following:

class BetaWebFetchToolResultErrorBlock:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

URL_TOO_LONG("url_too_long")

URL_NOT_ALLOWED("url_not_allowed")

URL_NOT_ACCESSIBLE("url_not_accessible")

UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")

TOO_MANY_REQUESTS("too_many_requests")

MAX_USES_EXCEEDED("max_uses_exceeded")

UNAVAILABLE("unavailable")

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

class BetaWebFetchBlock:

BetaDocumentBlock content

Optional<BetaCitationConfig> citations

Citation configuration for the document

boolean enabled

Source source

Accepts one of the following:

class BetaBase64PdfSource:

String data

formatbyte

JsonValue; mediaType

Accepts one of the following:

APPLICATION_PDF("application/pdf")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

String data

JsonValue; mediaType

Accepts one of the following:

TEXT_PLAIN("text/plain")

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<String> title

The title of the document

JsonValue; type

Accepts one of the following:

DOCUMENT("document")

Optional<String> retrievedAt

ISO 8601 timestamp when the content was retrieved

JsonValue; type

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

String url

Fetched content URL

String toolUseId

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT("web_fetch_tool_result")

class BetaCodeExecutionToolResultBlock:

Accepts one of the following:

class BetaCodeExecutionToolResultError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlock:

List<BetaCodeExecutionOutputBlock> content

String fileId

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

long returnCode

String stderr

String stdout

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

String toolUseId

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT("code_execution_tool_result")

class BetaBashCodeExecutionToolResultBlock:

Content content

Accepts one of the following:

class BetaBashCodeExecutionToolResultError:

ErrorCode errorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

OUTPUT_FILE_TOO_LARGE("output_file_too_large")

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")

class BetaBashCodeExecutionResultBlock:

List<BetaBashCodeExecutionOutputBlock> content

String fileId

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")

long returnCode

String stderr

String stdout

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")

String toolUseId

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT("bash_code_execution_tool_result")

class BetaTextEditorCodeExecutionToolResultBlock:

Content content

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultError:

ErrorCode errorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

FILE_NOT_FOUND("file_not_found")

Optional<String> errorMessage

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

class BetaTextEditorCodeExecutionViewResultBlock:

String content

FileType fileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

Optional<Long> numLines

Optional<Long> startLine

Optional<Long> totalLines

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

class BetaTextEditorCodeExecutionCreateResultBlock:

boolean isFileUpdate

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlock:

Optional<List<String>> lines

Optional<Long> newLines

Optional<Long> newStart

Optional<Long> oldLines

Optional<Long> oldStart

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

String toolUseId

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")

class BetaMcpToolUseBlock:

String id

Input input

String name

The name of the MCP tool

String serverName

The name of the MCP server

JsonValue; type

Accepts one of the following:

MCP_TOOL_USE("mcp_tool_use")

class BetaMcpToolResultBlock:

Content content

Accepts one of the following:

String

List<BetaTextBlock>

Optional<List<BetaTextCitation>> citations

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endCharIndex

Optional<String> fileId

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endPageNumber

Optional<String> fileId

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endBlockIndex

Optional<String> fileId

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

class BetaCitationSearchResultLocation:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

String text

maxLength5000000

minLength0

JsonValue; type

Accepts one of the following:

TEXT("text")

boolean isError

String toolUseId

JsonValue; type

Accepts one of the following:

MCP_TOOL_RESULT("mcp_tool_result")

class BetaContainerUploadBlock:

Response model for a file uploaded to the container.

String fileId

JsonValue; type

Accepts one of the following:

CONTAINER_UPLOAD("container_upload")

long index

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_START("content_block_start")

class BetaRawContentBlockStopEvent:

long index

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_STOP("content_block_stop")

class BetaRawMessageDeltaEvent:

Optional<BetaContextManagementResponse> contextManagement

Information about context management strategies applied during the request

List<AppliedEdit> appliedEdits

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse:

long clearedInputTokens

Number of input tokens cleared by this edit.

minimum0

long clearedToolUses

Number of tool uses that were cleared.

minimum0

JsonValue; type

The type of context management edit applied.

Accepts one of the following:

CLEAR_TOOL_USES_20250919("clear_tool_uses_20250919")

class BetaClearThinking20251015EditResponse:

long clearedInputTokens

Number of input tokens cleared by this edit.

minimum0

long clearedThinkingTurns

Number of thinking turns that were cleared.

minimum0

JsonValue; type

The type of context management edit applied.

Accepts one of the following:

CLEAR_THINKING_20251015("clear_thinking_20251015")

Delta delta

Optional<BetaContainer> container

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.

formatdate-time

Optional<List<BetaSkill>> skills

Skills loaded in the container

String skillId

Skill ID

maxLength64

minLength1

Type type

Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)

Accepts one of the following:

ANTHROPIC("anthropic")

CUSTOM("custom")

String version

Skill version or 'latest' for most recent version

maxLength64

minLength1

Optional<BetaStopReason> stopReason

Accepts one of the following:

END_TURN("end_turn")

MAX_TOKENS("max_tokens")

STOP_SEQUENCE("stop_sequence")

TOOL_USE("tool_use")

PAUSE_TURN("pause_turn")

REFUSAL("refusal")

MODEL_CONTEXT_WINDOW_EXCEEDED("model_context_window_exceeded")

Optional<String> stopSequence

JsonValue; type

Accepts one of the following:

MESSAGE_DELTA("message_delta")

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.

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.

minimum0

Optional<Long> cacheReadInputTokens

The cumulative number of input tokens read from the cache.

minimum0

Optional<Long> inputTokens

The cumulative number of input tokens which were used.

minimum0

long outputTokens

The cumulative number of output tokens which were used.

Optional<BetaServerToolUsage> serverToolUse

The number of server tool requests.

long webFetchRequests

The number of web fetch tool requests.

minimum0

long webSearchRequests

The number of web search tool requests.

minimum0

class BetaRawMessageStartEvent:

BetaMessage message

String id

Unique object identifier.

The format and length of IDs may change over time.

Optional<BetaContainer> container

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.

formatdate-time

Optional<List<BetaSkill>> skills

Skills loaded in the container

String skillId

Skill ID

maxLength64

minLength1

Type type

Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)

Accepts one of the following:

ANTHROPIC("anthropic")

CUSTOM("custom")

String version

Skill version or 'latest' for most recent version

maxLength64

minLength1

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)"}]

Accepts one of the following:

class BetaTextBlock:

Optional<List<BetaTextCitation>> citations

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endCharIndex

Optional<String> fileId

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endPageNumber

Optional<String> fileId

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endBlockIndex

Optional<String> fileId

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

class BetaCitationSearchResultLocation:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

String text

maxLength5000000

minLength0

JsonValue; type

Accepts one of the following:

TEXT("text")

class BetaThinkingBlock:

String signature

String thinking

JsonValue; type

Accepts one of the following:

THINKING("thinking")

class BetaRedactedThinkingBlock:

String data

JsonValue; type

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaToolUseBlock:

String id

Input input

String name

minLength1

JsonValue; type

Accepts one of the following:

TOOL_USE("tool_use")

class BetaServerToolUseBlock:

String id

Input input

Name name

Accepts one of the following:

WEB_SEARCH("web_search")

WEB_FETCH("web_fetch")

CODE_EXECUTION("code_execution")

BASH_CODE_EXECUTION("bash_code_execution")

TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")

JsonValue; type

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

class BetaWebSearchToolResultBlock:

Accepts one of the following:

class BetaWebSearchToolResultError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

MAX_USES_EXCEEDED("max_uses_exceeded")

TOO_MANY_REQUESTS("too_many_requests")

QUERY_TOO_LONG("query_too_long")

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

String encryptedContent

Optional<String> pageAge

String title

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

String url

String toolUseId

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT("web_search_tool_result")

class BetaWebFetchToolResultBlock:

Content content

Accepts one of the following:

class BetaWebFetchToolResultErrorBlock:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

URL_TOO_LONG("url_too_long")

URL_NOT_ALLOWED("url_not_allowed")

URL_NOT_ACCESSIBLE("url_not_accessible")

UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")

TOO_MANY_REQUESTS("too_many_requests")

MAX_USES_EXCEEDED("max_uses_exceeded")

UNAVAILABLE("unavailable")

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

class BetaWebFetchBlock:

BetaDocumentBlock content

Optional<BetaCitationConfig> citations

Citation configuration for the document

boolean enabled

Source source

Accepts one of the following:

class BetaBase64PdfSource:

String data

formatbyte

JsonValue; mediaType

Accepts one of the following:

APPLICATION_PDF("application/pdf")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

String data

JsonValue; mediaType

Accepts one of the following:

TEXT_PLAIN("text/plain")

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<String> title

The title of the document

JsonValue; type

Accepts one of the following:

DOCUMENT("document")

Optional<String> retrievedAt

ISO 8601 timestamp when the content was retrieved

JsonValue; type

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

String url

Fetched content URL

String toolUseId

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT("web_fetch_tool_result")

class BetaCodeExecutionToolResultBlock:

Accepts one of the following:

class BetaCodeExecutionToolResultError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlock:

List<BetaCodeExecutionOutputBlock> content

String fileId

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

long returnCode

String stderr

String stdout

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

String toolUseId

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT("code_execution_tool_result")

class BetaBashCodeExecutionToolResultBlock:

Content content

Accepts one of the following:

class BetaBashCodeExecutionToolResultError:

ErrorCode errorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

OUTPUT_FILE_TOO_LARGE("output_file_too_large")

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")

class BetaBashCodeExecutionResultBlock:

List<BetaBashCodeExecutionOutputBlock> content

String fileId

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")

long returnCode

String stderr

String stdout

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")

String toolUseId

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT("bash_code_execution_tool_result")

class BetaTextEditorCodeExecutionToolResultBlock:

Content content

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultError:

ErrorCode errorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

FILE_NOT_FOUND("file_not_found")

Optional<String> errorMessage

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

class BetaTextEditorCodeExecutionViewResultBlock:

String content

FileType fileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

Optional<Long> numLines

Optional<Long> startLine

Optional<Long> totalLines

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

class BetaTextEditorCodeExecutionCreateResultBlock:

boolean isFileUpdate

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlock:

Optional<List<String>> lines

Optional<Long> newLines

Optional<Long> newStart

Optional<Long> oldLines

Optional<Long> oldStart

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

String toolUseId

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")

class BetaMcpToolUseBlock:

String id

Input input

String name

The name of the MCP tool

String serverName

The name of the MCP server

JsonValue; type

Accepts one of the following:

MCP_TOOL_USE("mcp_tool_use")

class BetaMcpToolResultBlock:

Content content

Accepts one of the following:

String

List<BetaTextBlock>

Optional<List<BetaTextCitation>> citations

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endCharIndex

Optional<String> fileId

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endPageNumber

Optional<String> fileId

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endBlockIndex

Optional<String> fileId

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

class BetaCitationSearchResultLocation:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

String text

maxLength5000000

minLength0

JsonValue; type

Accepts one of the following:

TEXT("text")

boolean isError

String toolUseId

JsonValue; type

Accepts one of the following:

MCP_TOOL_RESULT("mcp_tool_result")

class BetaContainerUploadBlock:

Response model for a file uploaded to the container.

String fileId

JsonValue; type

Accepts one of the following:

CONTAINER_UPLOAD("container_upload")

Optional<BetaContextManagementResponse> contextManagement

Context management response.

Information about context management strategies applied during the request.

List<AppliedEdit> appliedEdits

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse:

long clearedInputTokens

Number of input tokens cleared by this edit.

minimum0

long clearedToolUses

Number of tool uses that were cleared.

minimum0

JsonValue; type

The type of context management edit applied.

Accepts one of the following:

CLEAR_TOOL_USES_20250919("clear_tool_uses_20250919")

class BetaClearThinking20251015EditResponse:

long clearedInputTokens

Number of input tokens cleared by this edit.

minimum0

long clearedThinkingTurns

Number of thinking turns that were cleared.

minimum0

JsonValue; type

The type of context management edit applied.

Accepts one of the following:

CLEAR_THINKING_20251015("clear_thinking_20251015")

Model model

The model that will complete your prompt.

See models for additional details and options.

Accepts one of the following:

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

Conversational role of the generated message.

This will always be "assistant".

Accepts one of the following:

ASSISTANT("assistant")

Optional<BetaStopReason> stopReason

The reason that we stopped.

This may be one the following values:

"end_turn": the model reached a natural stopping point
"max_tokens": we exceeded the requested max_tokens or the model's maximum
"stop_sequence": one of your provided custom stop_sequences was generated
"tool_use": the model invoked one or more tools
"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue.
"refusal": when streaming classifiers intervene to handle potential policy violations

In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.

Accepts one of the following:

END_TURN("end_turn")

MAX_TOKENS("max_tokens")

STOP_SEQUENCE("stop_sequence")

TOOL_USE("tool_use")

PAUSE_TURN("pause_turn")

REFUSAL("refusal")

MODEL_CONTEXT_WINDOW_EXCEEDED("model_context_window_exceeded")

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

Object type.

For Messages, this is always "message".

Accepts one of the following:

MESSAGE("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.

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<BetaCacheCreation> cacheCreation

Breakdown of cached tokens by TTL

long ephemeral1hInputTokens

The number of input tokens used to create the 1 hour cache entry.

minimum0

long ephemeral5mInputTokens

The number of input tokens used to create the 5 minute cache entry.

minimum0

Optional<Long> cacheCreationInputTokens

The number of input tokens used to create the cache entry.

minimum0

Optional<Long> cacheReadInputTokens

The number of input tokens read from the cache.

minimum0

long inputTokens

The number of input tokens which were used.

minimum0

long outputTokens

The number of output tokens which were used.

minimum0

Optional<BetaServerToolUsage> serverToolUse

The number of server tool requests.

long webFetchRequests

The number of web fetch tool requests.

minimum0

long webSearchRequests

The number of web search tool requests.

minimum0

Optional<ServiceTier> serviceTier

If the request used the priority, standard, or batch tier.

Accepts one of the following:

STANDARD("standard")

PRIORITY("priority")

BATCH("batch")

JsonValue; type

Accepts one of the following:

MESSAGE_START("message_start")

class BetaRawMessageStopEvent:

JsonValue; type

Accepts one of the following:

MESSAGE_STOP("message_stop")

class BetaRawMessageStreamEvent:

class BetaRawMessageStartEvent:

BetaMessage message

String id

Unique object identifier.

The format and length of IDs may change over time.

Optional<BetaContainer> container

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.

formatdate-time

Optional<List<BetaSkill>> skills

Skills loaded in the container

String skillId

Skill ID

maxLength64

minLength1

Type type

Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)

Accepts one of the following:

ANTHROPIC("anthropic")

CUSTOM("custom")

String version

Skill version or 'latest' for most recent version

maxLength64

minLength1

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)"}]

Accepts one of the following:

class BetaTextBlock:

Optional<List<BetaTextCitation>> citations

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endCharIndex

Optional<String> fileId

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endPageNumber

Optional<String> fileId

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endBlockIndex

Optional<String> fileId

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

class BetaCitationSearchResultLocation:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

String text

maxLength5000000

minLength0

JsonValue; type

Accepts one of the following:

TEXT("text")

class BetaThinkingBlock:

String signature

String thinking

JsonValue; type

Accepts one of the following:

THINKING("thinking")

class BetaRedactedThinkingBlock:

String data

JsonValue; type

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaToolUseBlock:

String id

Input input

String name

minLength1

JsonValue; type

Accepts one of the following:

TOOL_USE("tool_use")

class BetaServerToolUseBlock:

String id

Input input

Name name

Accepts one of the following:

WEB_SEARCH("web_search")

WEB_FETCH("web_fetch")

CODE_EXECUTION("code_execution")

BASH_CODE_EXECUTION("bash_code_execution")

TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")

JsonValue; type

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

class BetaWebSearchToolResultBlock:

Accepts one of the following:

class BetaWebSearchToolResultError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

MAX_USES_EXCEEDED("max_uses_exceeded")

TOO_MANY_REQUESTS("too_many_requests")

QUERY_TOO_LONG("query_too_long")

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

String encryptedContent

Optional<String> pageAge

String title

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

String url

String toolUseId

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT("web_search_tool_result")

class BetaWebFetchToolResultBlock:

Content content

Accepts one of the following:

class BetaWebFetchToolResultErrorBlock:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

URL_TOO_LONG("url_too_long")

URL_NOT_ALLOWED("url_not_allowed")

URL_NOT_ACCESSIBLE("url_not_accessible")

UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")

TOO_MANY_REQUESTS("too_many_requests")

MAX_USES_EXCEEDED("max_uses_exceeded")

UNAVAILABLE("unavailable")

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

class BetaWebFetchBlock:

BetaDocumentBlock content

Optional<BetaCitationConfig> citations

Citation configuration for the document

boolean enabled

Source source

Accepts one of the following:

class BetaBase64PdfSource:

String data

formatbyte

JsonValue; mediaType

Accepts one of the following:

APPLICATION_PDF("application/pdf")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

String data

JsonValue; mediaType

Accepts one of the following:

TEXT_PLAIN("text/plain")

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<String> title

The title of the document

JsonValue; type

Accepts one of the following:

DOCUMENT("document")

Optional<String> retrievedAt

ISO 8601 timestamp when the content was retrieved

JsonValue; type

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

String url

Fetched content URL

String toolUseId

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT("web_fetch_tool_result")

class BetaCodeExecutionToolResultBlock:

Accepts one of the following:

class BetaCodeExecutionToolResultError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlock:

List<BetaCodeExecutionOutputBlock> content

String fileId

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

long returnCode

String stderr

String stdout

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

String toolUseId

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT("code_execution_tool_result")

class BetaBashCodeExecutionToolResultBlock:

Content content

Accepts one of the following:

class BetaBashCodeExecutionToolResultError:

ErrorCode errorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

OUTPUT_FILE_TOO_LARGE("output_file_too_large")

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")

class BetaBashCodeExecutionResultBlock:

List<BetaBashCodeExecutionOutputBlock> content

String fileId

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")

long returnCode

String stderr

String stdout

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")

String toolUseId

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT("bash_code_execution_tool_result")

class BetaTextEditorCodeExecutionToolResultBlock:

Content content

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultError:

ErrorCode errorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

FILE_NOT_FOUND("file_not_found")

Optional<String> errorMessage

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

class BetaTextEditorCodeExecutionViewResultBlock:

String content

FileType fileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

Optional<Long> numLines

Optional<Long> startLine

Optional<Long> totalLines

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

class BetaTextEditorCodeExecutionCreateResultBlock:

boolean isFileUpdate

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlock:

Optional<List<String>> lines

Optional<Long> newLines

Optional<Long> newStart

Optional<Long> oldLines

Optional<Long> oldStart

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

String toolUseId

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")

class BetaMcpToolUseBlock:

String id

Input input

String name

The name of the MCP tool

String serverName

The name of the MCP server

JsonValue; type

Accepts one of the following:

MCP_TOOL_USE("mcp_tool_use")

class BetaMcpToolResultBlock:

Content content

Accepts one of the following:

String

List<BetaTextBlock>

Optional<List<BetaTextCitation>> citations

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endCharIndex

Optional<String> fileId

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endPageNumber

Optional<String> fileId

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endBlockIndex

Optional<String> fileId

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

class BetaCitationSearchResultLocation:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

String text

maxLength5000000

minLength0

JsonValue; type

Accepts one of the following:

TEXT("text")

boolean isError

String toolUseId

JsonValue; type

Accepts one of the following:

MCP_TOOL_RESULT("mcp_tool_result")

class BetaContainerUploadBlock:

Response model for a file uploaded to the container.

String fileId

JsonValue; type

Accepts one of the following:

CONTAINER_UPLOAD("container_upload")

Optional<BetaContextManagementResponse> contextManagement

Context management response.

Information about context management strategies applied during the request.

List<AppliedEdit> appliedEdits

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse:

long clearedInputTokens

Number of input tokens cleared by this edit.

minimum0

long clearedToolUses

Number of tool uses that were cleared.

minimum0

JsonValue; type

The type of context management edit applied.

Accepts one of the following:

CLEAR_TOOL_USES_20250919("clear_tool_uses_20250919")

class BetaClearThinking20251015EditResponse:

long clearedInputTokens

Number of input tokens cleared by this edit.

minimum0

long clearedThinkingTurns

Number of thinking turns that were cleared.

minimum0

JsonValue; type

The type of context management edit applied.

Accepts one of the following:

CLEAR_THINKING_20251015("clear_thinking_20251015")

Model model

The model that will complete your prompt.

See models for additional details and options.

Accepts one of the following:

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

Conversational role of the generated message.

This will always be "assistant".

Accepts one of the following:

ASSISTANT("assistant")

Optional<BetaStopReason> stopReason

The reason that we stopped.

This may be one the following values:

"end_turn": the model reached a natural stopping point
"max_tokens": we exceeded the requested max_tokens or the model's maximum
"stop_sequence": one of your provided custom stop_sequences was generated
"tool_use": the model invoked one or more tools
"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue.
"refusal": when streaming classifiers intervene to handle potential policy violations

In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.

Accepts one of the following:

END_TURN("end_turn")

MAX_TOKENS("max_tokens")

STOP_SEQUENCE("stop_sequence")

TOOL_USE("tool_use")

PAUSE_TURN("pause_turn")

REFUSAL("refusal")

MODEL_CONTEXT_WINDOW_EXCEEDED("model_context_window_exceeded")

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

Object type.

For Messages, this is always "message".

Accepts one of the following:

MESSAGE("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.

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<BetaCacheCreation> cacheCreation

Breakdown of cached tokens by TTL

long ephemeral1hInputTokens

The number of input tokens used to create the 1 hour cache entry.

minimum0

long ephemeral5mInputTokens

The number of input tokens used to create the 5 minute cache entry.

minimum0

Optional<Long> cacheCreationInputTokens

The number of input tokens used to create the cache entry.

minimum0

Optional<Long> cacheReadInputTokens

The number of input tokens read from the cache.

minimum0

long inputTokens

The number of input tokens which were used.

minimum0

long outputTokens

The number of output tokens which were used.

minimum0

Optional<BetaServerToolUsage> serverToolUse

The number of server tool requests.

long webFetchRequests

The number of web fetch tool requests.

minimum0

long webSearchRequests

The number of web search tool requests.

minimum0

Optional<ServiceTier> serviceTier

If the request used the priority, standard, or batch tier.

Accepts one of the following:

STANDARD("standard")

PRIORITY("priority")

BATCH("batch")

JsonValue; type

Accepts one of the following:

MESSAGE_START("message_start")

class BetaRawMessageDeltaEvent:

Optional<BetaContextManagementResponse> contextManagement

Information about context management strategies applied during the request

List<AppliedEdit> appliedEdits

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse:

long clearedInputTokens

Number of input tokens cleared by this edit.

minimum0

long clearedToolUses

Number of tool uses that were cleared.

minimum0

JsonValue; type

The type of context management edit applied.

Accepts one of the following:

CLEAR_TOOL_USES_20250919("clear_tool_uses_20250919")

class BetaClearThinking20251015EditResponse:

long clearedInputTokens

Number of input tokens cleared by this edit.

minimum0

long clearedThinkingTurns

Number of thinking turns that were cleared.

minimum0

JsonValue; type

The type of context management edit applied.

Accepts one of the following:

CLEAR_THINKING_20251015("clear_thinking_20251015")

Delta delta

Optional<BetaContainer> container

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.

formatdate-time

Optional<List<BetaSkill>> skills

Skills loaded in the container

String skillId

Skill ID

maxLength64

minLength1

Type type

Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)

Accepts one of the following:

ANTHROPIC("anthropic")

CUSTOM("custom")

String version

Skill version or 'latest' for most recent version

maxLength64

minLength1

Optional<BetaStopReason> stopReason

Accepts one of the following:

END_TURN("end_turn")

MAX_TOKENS("max_tokens")

STOP_SEQUENCE("stop_sequence")

TOOL_USE("tool_use")

PAUSE_TURN("pause_turn")

REFUSAL("refusal")

MODEL_CONTEXT_WINDOW_EXCEEDED("model_context_window_exceeded")

Optional<String> stopSequence

JsonValue; type

Accepts one of the following:

MESSAGE_DELTA("message_delta")

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.

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.

minimum0

Optional<Long> cacheReadInputTokens

The cumulative number of input tokens read from the cache.

minimum0

Optional<Long> inputTokens

The cumulative number of input tokens which were used.

minimum0

long outputTokens

The cumulative number of output tokens which were used.

Optional<BetaServerToolUsage> serverToolUse

The number of server tool requests.

long webFetchRequests

The number of web fetch tool requests.

minimum0

long webSearchRequests

The number of web search tool requests.

minimum0

class BetaRawMessageStopEvent:

JsonValue; type

Accepts one of the following:

MESSAGE_STOP("message_stop")

class BetaRawContentBlockStartEvent:

ContentBlock contentBlock

Response model for a file uploaded to the container.

Accepts one of the following:

class BetaTextBlock:

Optional<List<BetaTextCitation>> citations

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endCharIndex

Optional<String> fileId

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endPageNumber

Optional<String> fileId

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endBlockIndex

Optional<String> fileId

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

class BetaCitationSearchResultLocation:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

String text

maxLength5000000

minLength0

JsonValue; type

Accepts one of the following:

TEXT("text")

class BetaThinkingBlock:

String signature

String thinking

JsonValue; type

Accepts one of the following:

THINKING("thinking")

class BetaRedactedThinkingBlock:

String data

JsonValue; type

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaToolUseBlock:

String id

Input input

String name

minLength1

JsonValue; type

Accepts one of the following:

TOOL_USE("tool_use")

class BetaServerToolUseBlock:

String id

Input input

Name name

Accepts one of the following:

WEB_SEARCH("web_search")

WEB_FETCH("web_fetch")

CODE_EXECUTION("code_execution")

BASH_CODE_EXECUTION("bash_code_execution")

TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")

JsonValue; type

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

class BetaWebSearchToolResultBlock:

Accepts one of the following:

class BetaWebSearchToolResultError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

MAX_USES_EXCEEDED("max_uses_exceeded")

TOO_MANY_REQUESTS("too_many_requests")

QUERY_TOO_LONG("query_too_long")

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

String encryptedContent

Optional<String> pageAge

String title

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

String url

String toolUseId

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT("web_search_tool_result")

class BetaWebFetchToolResultBlock:

Content content

Accepts one of the following:

class BetaWebFetchToolResultErrorBlock:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

URL_TOO_LONG("url_too_long")

URL_NOT_ALLOWED("url_not_allowed")

URL_NOT_ACCESSIBLE("url_not_accessible")

UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")

TOO_MANY_REQUESTS("too_many_requests")

MAX_USES_EXCEEDED("max_uses_exceeded")

UNAVAILABLE("unavailable")

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

class BetaWebFetchBlock:

BetaDocumentBlock content

Optional<BetaCitationConfig> citations

Citation configuration for the document

boolean enabled

Source source

Accepts one of the following:

class BetaBase64PdfSource:

String data

formatbyte

JsonValue; mediaType

Accepts one of the following:

APPLICATION_PDF("application/pdf")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

String data

JsonValue; mediaType

Accepts one of the following:

TEXT_PLAIN("text/plain")

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<String> title

The title of the document

JsonValue; type

Accepts one of the following:

DOCUMENT("document")

Optional<String> retrievedAt

ISO 8601 timestamp when the content was retrieved

JsonValue; type

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

String url

Fetched content URL

String toolUseId

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT("web_fetch_tool_result")

class BetaCodeExecutionToolResultBlock:

Accepts one of the following:

class BetaCodeExecutionToolResultError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlock:

List<BetaCodeExecutionOutputBlock> content

String fileId

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

long returnCode

String stderr

String stdout

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

String toolUseId

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT("code_execution_tool_result")

class BetaBashCodeExecutionToolResultBlock:

Content content

Accepts one of the following:

class BetaBashCodeExecutionToolResultError:

ErrorCode errorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

OUTPUT_FILE_TOO_LARGE("output_file_too_large")

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")

class BetaBashCodeExecutionResultBlock:

List<BetaBashCodeExecutionOutputBlock> content

String fileId

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")

long returnCode

String stderr

String stdout

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")

String toolUseId

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT("bash_code_execution_tool_result")

class BetaTextEditorCodeExecutionToolResultBlock:

Content content

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultError:

ErrorCode errorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

FILE_NOT_FOUND("file_not_found")

Optional<String> errorMessage

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

class BetaTextEditorCodeExecutionViewResultBlock:

String content

FileType fileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

Optional<Long> numLines

Optional<Long> startLine

Optional<Long> totalLines

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

class BetaTextEditorCodeExecutionCreateResultBlock:

boolean isFileUpdate

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlock:

Optional<List<String>> lines

Optional<Long> newLines

Optional<Long> newStart

Optional<Long> oldLines

Optional<Long> oldStart

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

String toolUseId

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")

class BetaMcpToolUseBlock:

String id

Input input

String name

The name of the MCP tool

String serverName

The name of the MCP server

JsonValue; type

Accepts one of the following:

MCP_TOOL_USE("mcp_tool_use")

class BetaMcpToolResultBlock:

Content content

Accepts one of the following:

String

List<BetaTextBlock>

Optional<List<BetaTextCitation>> citations

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endCharIndex

Optional<String> fileId

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endPageNumber

Optional<String> fileId

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endBlockIndex

Optional<String> fileId

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

class BetaCitationSearchResultLocation:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

String text

maxLength5000000

minLength0

JsonValue; type

Accepts one of the following:

TEXT("text")

boolean isError

String toolUseId

JsonValue; type

Accepts one of the following:

MCP_TOOL_RESULT("mcp_tool_result")

class BetaContainerUploadBlock:

Response model for a file uploaded to the container.

String fileId

JsonValue; type

Accepts one of the following:

CONTAINER_UPLOAD("container_upload")

long index

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_START("content_block_start")

class BetaRawContentBlockDeltaEvent:

BetaRawContentBlockDelta delta

Accepts one of the following:

class BetaTextDelta:

String text

JsonValue; type

Accepts one of the following:

TEXT_DELTA("text_delta")

class BetaInputJsonDelta:

String partialJson

JsonValue; type

Accepts one of the following:

INPUT_JSON_DELTA("input_json_delta")

class BetaCitationsDelta:

Citation citation

Accepts one of the following:

class BetaCitationCharLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endCharIndex

Optional<String> fileId

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endPageNumber

Optional<String> fileId

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endBlockIndex

Optional<String> fileId

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

class BetaCitationSearchResultLocation:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

JsonValue; type

Accepts one of the following:

CITATIONS_DELTA("citations_delta")

class BetaThinkingDelta:

String thinking

JsonValue; type

Accepts one of the following:

THINKING_DELTA("thinking_delta")

class BetaSignatureDelta:

String signature

JsonValue; type

Accepts one of the following:

SIGNATURE_DELTA("signature_delta")

long index

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_DELTA("content_block_delta")

class BetaRawContentBlockStopEvent:

long index

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_STOP("content_block_stop")

class BetaRedactedThinkingBlock:

String data

JsonValue; type

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaRedactedThinkingBlockParam:

String data

JsonValue; type

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaRequestDocumentBlock:

Source source

Accepts one of the following:

class BetaBase64PdfSource:

String data

formatbyte

JsonValue; mediaType

Accepts one of the following:

APPLICATION_PDF("application/pdf")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

String data

JsonValue; mediaType

Accepts one of the following:

TEXT_PLAIN("text/plain")

JsonValue; type

Accepts one of the following:

TEXT("text")

class BetaContentBlockSource:

Content content

Accepts one of the following:

String

Accepts one of the following:

class BetaTextBlockParam:

String text

minLength1

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<List<BetaTextCitationParam>> citations

Accepts one of the following:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

Source source

Accepts one of the following:

class BetaBase64ImageSource:

String data

formatbyte

MediaType mediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileImageSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

IMAGE("image")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

JsonValue; type

Accepts one of the following:

CONTENT("content")

class BetaUrlPdfSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileDocumentSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

DOCUMENT("document")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<BetaCitationsConfigParam> citations

Optional<Boolean> enabled

Optional<String> context

minLength1

Optional<String> title

maxLength500

minLength1

class BetaRequestMcpServerToolConfiguration:

Optional<List<String>> allowedTools

Optional<Boolean> enabled

class BetaRequestMcpServerUrlDefinition:

String name

JsonValue; type

Accepts one of the following:

URL("url")

String url

Optional<String> authorizationToken

Optional<BetaRequestMcpServerToolConfiguration> toolConfiguration

Optional<List<String>> allowedTools

Optional<Boolean> enabled

class BetaRequestMcpToolResultBlockParam:

String toolUseId

JsonValue; type

Accepts one of the following:

MCP_TOOL_RESULT("mcp_tool_result")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<Content> content

Accepts one of the following:

String

List<BetaTextBlockParam>

String text

minLength1

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<List<BetaTextCitationParam>> citations

Accepts one of the following:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

Optional<Boolean> isError

class BetaSearchResultBlockParam:

List<BetaTextBlockParam> content

String text

minLength1

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<List<BetaTextCitationParam>> citations

Accepts one of the following:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

String source

String title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT("search_result")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<BetaCitationsConfigParam> citations

Optional<Boolean> enabled

class BetaServerToolUsage:

long webFetchRequests

The number of web fetch tool requests.

minimum0

long webSearchRequests

The number of web search tool requests.

minimum0

class BetaServerToolUseBlock:

String id

Input input

Name name

Accepts one of the following:

WEB_SEARCH("web_search")

WEB_FETCH("web_fetch")

CODE_EXECUTION("code_execution")

BASH_CODE_EXECUTION("bash_code_execution")

TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")

JsonValue; type

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

class BetaServerToolUseBlockParam:

String id

Input input

Name name

Accepts one of the following:

WEB_SEARCH("web_search")

WEB_FETCH("web_fetch")

CODE_EXECUTION("code_execution")

BASH_CODE_EXECUTION("bash_code_execution")

TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")

JsonValue; type

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaSignatureDelta:

String signature

JsonValue; type

Accepts one of the following:

SIGNATURE_DELTA("signature_delta")

class BetaSkill:

A skill that was loaded in a container (response model).

String skillId

Skill ID

maxLength64

minLength1

Type type

Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)

Accepts one of the following:

ANTHROPIC("anthropic")

CUSTOM("custom")

String version

Skill version or 'latest' for most recent version

maxLength64

minLength1

class BetaSkillParams:

Specification for a skill to be loaded in a container (request model).

String skillId

Skill ID

maxLength64

minLength1

Type type

Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)

Accepts one of the following:

ANTHROPIC("anthropic")

CUSTOM("custom")

Optional<String> version

Skill version or 'latest' for most recent version

maxLength64

minLength1

enum BetaStopReason:

END_TURN("end_turn")

MAX_TOKENS("max_tokens")

STOP_SEQUENCE("stop_sequence")

TOOL_USE("tool_use")

PAUSE_TURN("pause_turn")

REFUSAL("refusal")

MODEL_CONTEXT_WINDOW_EXCEEDED("model_context_window_exceeded")

class BetaTextBlock:

Optional<List<BetaTextCitation>> citations

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endCharIndex

Optional<String> fileId

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endPageNumber

Optional<String> fileId

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endBlockIndex

Optional<String> fileId

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

class BetaCitationSearchResultLocation:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

String text

maxLength5000000

minLength0

JsonValue; type

Accepts one of the following:

TEXT("text")

class BetaTextBlockParam:

String text

minLength1

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<List<BetaTextCitationParam>> citations

Accepts one of the following:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaTextCitation:

class BetaCitationCharLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endCharIndex

Optional<String> fileId

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endPageNumber

Optional<String> fileId

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endBlockIndex

Optional<String> fileId

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

class BetaCitationSearchResultLocation:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaTextCitationParam:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaTextDelta:

String text

JsonValue; type

Accepts one of the following:

TEXT_DELTA("text_delta")

class BetaTextEditorCodeExecutionCreateResultBlock:

boolean isFileUpdate

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionCreateResultBlockParam:

boolean isFileUpdate

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlock:

Optional<List<String>> lines

Optional<Long> newLines

Optional<Long> newStart

Optional<Long> oldLines

Optional<Long> oldStart

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlockParam:

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

Optional<List<String>> lines

Optional<Long> newLines

Optional<Long> newStart

Optional<Long> oldLines

Optional<Long> oldStart

class BetaTextEditorCodeExecutionToolResultBlock:

Content content

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultError:

ErrorCode errorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

FILE_NOT_FOUND("file_not_found")

Optional<String> errorMessage

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

class BetaTextEditorCodeExecutionViewResultBlock:

String content

FileType fileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

Optional<Long> numLines

Optional<Long> startLine

Optional<Long> totalLines

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

class BetaTextEditorCodeExecutionCreateResultBlock:

boolean isFileUpdate

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlock:

Optional<List<String>> lines

Optional<Long> newLines

Optional<Long> newStart

Optional<Long> oldLines

Optional<Long> oldStart

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

String toolUseId

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")

class BetaTextEditorCodeExecutionToolResultBlockParam:

Content content

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultErrorParam:

ErrorCode errorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

FILE_NOT_FOUND("file_not_found")

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

Optional<String> errorMessage

class BetaTextEditorCodeExecutionViewResultBlockParam:

String content

FileType fileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

Optional<Long> numLines

Optional<Long> startLine

Optional<Long> totalLines

class BetaTextEditorCodeExecutionCreateResultBlockParam:

boolean isFileUpdate

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlockParam:

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

Optional<List<String>> lines

Optional<Long> newLines

Optional<Long> newStart

Optional<Long> oldLines

Optional<Long> oldStart

String toolUseId

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaTextEditorCodeExecutionToolResultError:

ErrorCode errorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

FILE_NOT_FOUND("file_not_found")

Optional<String> errorMessage

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

class BetaTextEditorCodeExecutionToolResultErrorParam:

ErrorCode errorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

FILE_NOT_FOUND("file_not_found")

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

Optional<String> errorMessage

class BetaTextEditorCodeExecutionViewResultBlock:

String content

FileType fileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

Optional<Long> numLines

Optional<Long> startLine

Optional<Long> totalLines

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

class BetaTextEditorCodeExecutionViewResultBlockParam:

String content

FileType fileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

Optional<Long> numLines

Optional<Long> startLine

Optional<Long> totalLines

class BetaThinkingBlock:

String signature

String thinking

JsonValue; type

Accepts one of the following:

THINKING("thinking")

class BetaThinkingBlockParam:

String signature

String thinking

JsonValue; type

Accepts one of the following:

THINKING("thinking")

class BetaThinkingConfigDisabled:

JsonValue; type

Accepts one of the following:

DISABLED("disabled")

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.

minimum1024

JsonValue; type

Accepts one of the following:

ENABLED("enabled")

class BetaThinkingConfigParam:

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.

minimum1024

JsonValue; type

Accepts one of the following:

ENABLED("enabled")

class BetaThinkingConfigDisabled:

JsonValue; type

Accepts one of the following:

DISABLED("disabled")

class BetaThinkingDelta:

String thinking

JsonValue; type

Accepts one of the following:

THINKING_DELTA("thinking_delta")

class BetaThinkingTurns:

JsonValue; type

Accepts one of the following:

THINKING_TURNS("thinking_turns")

long value

minimum1

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

Accepts one of the following:

OBJECT("object")

Optional<Properties> properties

Optional<List<String>> required

String name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

maxLength128

minLength1

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

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

Accepts one of the following:

CUSTOM("custom")

class BetaToolBash20241022:

JsonValue; name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

Accepts one of the following:

BASH("bash")

JsonValue; type

Accepts one of the following:

BASH_20241022("bash_20241022")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaToolBash20250124:

JsonValue; name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

Accepts one of the following:

BASH("bash")

JsonValue; type

Accepts one of the following:

BASH_20250124("bash_20250124")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaToolChoice:

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

Accepts one of the following:

AUTO("auto")

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

Accepts one of the following:

ANY("any")

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

Accepts one of the following:

TOOL("tool")

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

Accepts one of the following:

NONE("none")

class BetaToolChoiceAny:

The model will use any available tools.

JsonValue; type

Accepts one of the following:

ANY("any")

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

Accepts one of the following:

AUTO("auto")

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

Accepts one of the following:

NONE("none")

class BetaToolChoiceTool:

The model will use the specified tool with tool_choice.name.

String name

The name of the tool to use.

JsonValue; type

Accepts one of the following:

TOOL("tool")

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.

minimum1

long displayWidthPx

The width of the display in pixels.

minimum1

JsonValue; name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

Accepts one of the following:

COMPUTER("computer")

JsonValue; type

Accepts one of the following:

COMPUTER_20241022("computer_20241022")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<Long> displayNumber

The X11 display number (e.g. 0, 1) for the display.

minimum0

class BetaToolComputerUse20250124:

long displayHeightPx

The height of the display in pixels.

minimum1

long displayWidthPx

The width of the display in pixels.

minimum1

JsonValue; name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

Accepts one of the following:

COMPUTER("computer")

JsonValue; type

Accepts one of the following:

COMPUTER_20250124("computer_20250124")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<Long> displayNumber

The X11 display number (e.g. 0, 1) for the display.

minimum0

class BetaToolResultBlockParam:

String toolUseId

JsonValue; type

Accepts one of the following:

TOOL_RESULT("tool_result")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<Content> content

Accepts one of the following:

String

List<Block>

Accepts one of the following:

class BetaTextBlockParam:

String text

minLength1

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<List<BetaTextCitationParam>> citations

Accepts one of the following:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

Source source

Accepts one of the following:

class BetaBase64ImageSource:

String data

formatbyte

MediaType mediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileImageSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

IMAGE("image")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaSearchResultBlockParam:

List<BetaTextBlockParam> content

String text

minLength1

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<List<BetaTextCitationParam>> citations

Accepts one of the following:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

String source

String title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT("search_result")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<BetaCitationsConfigParam> citations

Optional<Boolean> enabled

class BetaRequestDocumentBlock:

Source source

Accepts one of the following:

class BetaBase64PdfSource:

String data

formatbyte

JsonValue; mediaType

Accepts one of the following:

APPLICATION_PDF("application/pdf")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

String data

JsonValue; mediaType

Accepts one of the following:

TEXT_PLAIN("text/plain")

JsonValue; type

Accepts one of the following:

TEXT("text")

class BetaContentBlockSource:

Content content

Accepts one of the following:

String

Accepts one of the following:

class BetaTextBlockParam:

String text

minLength1

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<List<BetaTextCitationParam>> citations

Accepts one of the following:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

Source source

Accepts one of the following:

class BetaBase64ImageSource:

String data

formatbyte

MediaType mediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileImageSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

IMAGE("image")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

JsonValue; type

Accepts one of the following:

CONTENT("content")

class BetaUrlPdfSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileDocumentSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

DOCUMENT("document")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<BetaCitationsConfigParam> citations

Optional<Boolean> enabled

Optional<String> context

minLength1

Optional<String> title

maxLength500

minLength1

Optional<Boolean> isError

class BetaToolTextEditor20241022:

JsonValue; name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

Accepts one of the following:

STR_REPLACE_EDITOR("str_replace_editor")

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_20241022("text_editor_20241022")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaToolTextEditor20250124:

JsonValue; name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

Accepts one of the following:

STR_REPLACE_EDITOR("str_replace_editor")

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_20250124("text_editor_20250124")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaToolTextEditor20250429:

JsonValue; name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

Accepts one of the following:

STR_REPLACE_BASED_EDIT_TOOL("str_replace_based_edit_tool")

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_20250429("text_editor_20250429")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaToolTextEditor20250728:

JsonValue; name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

Accepts one of the following:

STR_REPLACE_BASED_EDIT_TOOL("str_replace_based_edit_tool")

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_20250728("text_editor_20250728")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<Long> maxCharacters

Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.

minimum1

class BetaToolUnion:

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

Accepts one of the following:

OBJECT("object")

Optional<Properties> properties

Optional<List<String>> required

String name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

maxLength128

minLength1

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<String> description

Description of what this tool does.

Optional<Type> type

Accepts one of the following:

CUSTOM("custom")

class BetaToolBash20241022:

JsonValue; name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

Accepts one of the following:

BASH("bash")

JsonValue; type

Accepts one of the following:

BASH_20241022("bash_20241022")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaToolBash20250124:

JsonValue; name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

Accepts one of the following:

BASH("bash")

JsonValue; type

Accepts one of the following:

BASH_20250124("bash_20250124")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaCodeExecutionTool20250522:

JsonValue; name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

Accepts one of the following:

CODE_EXECUTION("code_execution")

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_20250522("code_execution_20250522")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaCodeExecutionTool20250825:

JsonValue; name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

Accepts one of the following:

CODE_EXECUTION("code_execution")

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_20250825("code_execution_20250825")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaToolComputerUse20241022:

long displayHeightPx

The height of the display in pixels.

minimum1

long displayWidthPx

The width of the display in pixels.

minimum1

JsonValue; name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

Accepts one of the following:

COMPUTER("computer")

JsonValue; type

Accepts one of the following:

COMPUTER_20241022("computer_20241022")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<Long> displayNumber

The X11 display number (e.g. 0, 1) for the display.

minimum0

class BetaMemoryTool20250818:

JsonValue; name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

Accepts one of the following:

MEMORY("memory")

JsonValue; type

Accepts one of the following:

MEMORY_20250818("memory_20250818")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaToolComputerUse20250124:

long displayHeightPx

The height of the display in pixels.

minimum1

long displayWidthPx

The width of the display in pixels.

minimum1

JsonValue; name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

Accepts one of the following:

COMPUTER("computer")

JsonValue; type

Accepts one of the following:

COMPUTER_20250124("computer_20250124")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<Long> displayNumber

The X11 display number (e.g. 0, 1) for the display.

minimum0

class BetaToolTextEditor20241022:

JsonValue; name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

Accepts one of the following:

STR_REPLACE_EDITOR("str_replace_editor")

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_20241022("text_editor_20241022")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaToolTextEditor20250124:

JsonValue; name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

Accepts one of the following:

STR_REPLACE_EDITOR("str_replace_editor")

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_20250124("text_editor_20250124")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaToolTextEditor20250429:

JsonValue; name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

Accepts one of the following:

STR_REPLACE_BASED_EDIT_TOOL("str_replace_based_edit_tool")

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_20250429("text_editor_20250429")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaToolTextEditor20250728:

JsonValue; name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

Accepts one of the following:

STR_REPLACE_BASED_EDIT_TOOL("str_replace_based_edit_tool")

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_20250728("text_editor_20250728")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<Long> maxCharacters

Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.

minimum1

class BetaWebSearchTool20250305:

JsonValue; name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

Accepts one of the following:

WEB_SEARCH("web_search")

JsonValue; type

Accepts one of the following:

WEB_SEARCH_20250305("web_search_20250305")

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.

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<Long> maxUses

Maximum number of times the tool can be used in the API request.

exclusiveMinimum0

Optional<UserLocation> userLocation

Parameters for the user's location. Used to provide more relevant search results.

JsonValue; type

Accepts one of the following:

APPROXIMATE("approximate")

Optional<String> city

The city of the user.

maxLength255

minLength1

Optional<String> country

The two letter ISO country code of the user.

maxLength2

minLength2

Optional<String> region

The region of the user.

maxLength255

minLength1

Optional<String> timezone

The IANA timezone of the user.

maxLength255

minLength1

class BetaWebFetchTool20250910:

JsonValue; name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

Accepts one of the following:

WEB_FETCH("web_fetch")

JsonValue; type

Accepts one of the following:

WEB_FETCH_20250910("web_fetch_20250910")

Optional<List<String>> allowedDomains

List of domains to allow fetching from

Optional<List<String>> blockedDomains

List of domains to block fetching from

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<BetaCitationsConfigParam> citations

Citations configuration for fetched documents. Citations are disabled by default.

Optional<Boolean> enabled

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.

exclusiveMinimum0

Optional<Long> maxUses

Maximum number of times the tool can be used in the API request.

exclusiveMinimum0

class BetaToolUseBlock:

String id

Input input

String name

minLength1

JsonValue; type

Accepts one of the following:

TOOL_USE("tool_use")

class BetaToolUseBlockParam:

String id

Input input

String name

maxLength200

minLength1

JsonValue; type

Accepts one of the following:

TOOL_USE("tool_use")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaToolUsesKeep:

JsonValue; type

Accepts one of the following:

TOOL_USES("tool_uses")

long value

minimum0

class BetaToolUsesTrigger:

JsonValue; type

Accepts one of the following:

TOOL_USES("tool_uses")

long value

minimum1

class BetaUrlImageSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaUrlPdfSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaUsage:

Optional<BetaCacheCreation> cacheCreation

Breakdown of cached tokens by TTL

long ephemeral1hInputTokens

The number of input tokens used to create the 1 hour cache entry.

minimum0

long ephemeral5mInputTokens

The number of input tokens used to create the 5 minute cache entry.

minimum0

Optional<Long> cacheCreationInputTokens

The number of input tokens used to create the cache entry.

minimum0

Optional<Long> cacheReadInputTokens

The number of input tokens read from the cache.

minimum0

long inputTokens

The number of input tokens which were used.

minimum0

long outputTokens

The number of output tokens which were used.

minimum0

Optional<BetaServerToolUsage> serverToolUse

The number of server tool requests.

long webFetchRequests

The number of web fetch tool requests.

minimum0

long webSearchRequests

The number of web search tool requests.

minimum0

Optional<ServiceTier> serviceTier

If the request used the priority, standard, or batch tier.

Accepts one of the following:

STANDARD("standard")

PRIORITY("priority")

BATCH("batch")

class BetaWebFetchBlock:

BetaDocumentBlock content

Optional<BetaCitationConfig> citations

Citation configuration for the document

boolean enabled

Source source

Accepts one of the following:

class BetaBase64PdfSource:

String data

formatbyte

JsonValue; mediaType

Accepts one of the following:

APPLICATION_PDF("application/pdf")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

String data

JsonValue; mediaType

Accepts one of the following:

TEXT_PLAIN("text/plain")

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<String> title

The title of the document

JsonValue; type

Accepts one of the following:

DOCUMENT("document")

Optional<String> retrievedAt

ISO 8601 timestamp when the content was retrieved

JsonValue; type

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

String url

Fetched content URL

class BetaWebFetchBlockParam:

Source source

Accepts one of the following:

class BetaBase64PdfSource:

String data

formatbyte

JsonValue; mediaType

Accepts one of the following:

APPLICATION_PDF("application/pdf")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

String data

JsonValue; mediaType

Accepts one of the following:

TEXT_PLAIN("text/plain")

JsonValue; type

Accepts one of the following:

TEXT("text")

class BetaContentBlockSource:

Content content

Accepts one of the following:

String

Accepts one of the following:

class BetaTextBlockParam:

String text

minLength1

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<List<BetaTextCitationParam>> citations

Accepts one of the following:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

Source source

Accepts one of the following:

class BetaBase64ImageSource:

String data

formatbyte

MediaType mediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileImageSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

IMAGE("image")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

JsonValue; type

Accepts one of the following:

CONTENT("content")

class BetaUrlPdfSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileDocumentSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

DOCUMENT("document")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<BetaCitationsConfigParam> citations

Optional<Boolean> enabled

Optional<String> context

minLength1

Optional<String> title

maxLength500

minLength1

JsonValue; type

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

String url

Fetched content URL

Optional<String> retrievedAt

ISO 8601 timestamp when the content was retrieved

class BetaWebFetchTool20250910:

JsonValue; name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

Accepts one of the following:

WEB_FETCH("web_fetch")

JsonValue; type

Accepts one of the following:

WEB_FETCH_20250910("web_fetch_20250910")

Optional<List<String>> allowedDomains

List of domains to allow fetching from

Optional<List<String>> blockedDomains

List of domains to block fetching from

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<BetaCitationsConfigParam> citations

Citations configuration for fetched documents. Citations are disabled by default.

Optional<Boolean> enabled

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.

exclusiveMinimum0

Optional<Long> maxUses

Maximum number of times the tool can be used in the API request.

exclusiveMinimum0

class BetaWebFetchToolResultBlock:

Content content

Accepts one of the following:

class BetaWebFetchToolResultErrorBlock:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

URL_TOO_LONG("url_too_long")

URL_NOT_ALLOWED("url_not_allowed")

URL_NOT_ACCESSIBLE("url_not_accessible")

UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")

TOO_MANY_REQUESTS("too_many_requests")

MAX_USES_EXCEEDED("max_uses_exceeded")

UNAVAILABLE("unavailable")

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

class BetaWebFetchBlock:

BetaDocumentBlock content

Optional<BetaCitationConfig> citations

Citation configuration for the document

boolean enabled

Source source

Accepts one of the following:

class BetaBase64PdfSource:

String data

formatbyte

JsonValue; mediaType

Accepts one of the following:

APPLICATION_PDF("application/pdf")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

String data

JsonValue; mediaType

Accepts one of the following:

TEXT_PLAIN("text/plain")

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<String> title

The title of the document

JsonValue; type

Accepts one of the following:

DOCUMENT("document")

Optional<String> retrievedAt

ISO 8601 timestamp when the content was retrieved

JsonValue; type

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

String url

Fetched content URL

String toolUseId

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT("web_fetch_tool_result")

class BetaWebFetchToolResultBlockParam:

Content content

Accepts one of the following:

class BetaWebFetchToolResultErrorBlockParam:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

URL_TOO_LONG("url_too_long")

URL_NOT_ALLOWED("url_not_allowed")

URL_NOT_ACCESSIBLE("url_not_accessible")

UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")

TOO_MANY_REQUESTS("too_many_requests")

MAX_USES_EXCEEDED("max_uses_exceeded")

UNAVAILABLE("unavailable")

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

class BetaWebFetchBlockParam:

Source source

Accepts one of the following:

class BetaBase64PdfSource:

String data

formatbyte

JsonValue; mediaType

Accepts one of the following:

APPLICATION_PDF("application/pdf")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

String data

JsonValue; mediaType

Accepts one of the following:

TEXT_PLAIN("text/plain")

JsonValue; type

Accepts one of the following:

TEXT("text")

class BetaContentBlockSource:

Content content

Accepts one of the following:

String

Accepts one of the following:

class BetaTextBlockParam:

String text

minLength1

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<List<BetaTextCitationParam>> citations

Accepts one of the following:

class BetaCitationCharLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endCharIndex

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endPageNumber

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

maxLength255

minLength1

long endBlockIndex

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

minLength1

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

Source source

Accepts one of the following:

class BetaBase64ImageSource:

String data

formatbyte

MediaType mediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileImageSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

IMAGE("image")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

JsonValue; type

Accepts one of the following:

CONTENT("content")

class BetaUrlPdfSource:

JsonValue; type

Accepts one of the following:

URL("url")

String url

class BetaFileDocumentSource:

String fileId

JsonValue; type

Accepts one of the following:

FILE("file")

JsonValue; type

Accepts one of the following:

DOCUMENT("document")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<BetaCitationsConfigParam> citations

Optional<Boolean> enabled

Optional<String> context

minLength1

Optional<String> title

maxLength500

minLength1

JsonValue; type

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

String url

Fetched content URL

Optional<String> retrievedAt

ISO 8601 timestamp when the content was retrieved

String toolUseId

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT("web_fetch_tool_result")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaWebFetchToolResultErrorBlock:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

URL_TOO_LONG("url_too_long")

URL_NOT_ALLOWED("url_not_allowed")

URL_NOT_ACCESSIBLE("url_not_accessible")

UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")

TOO_MANY_REQUESTS("too_many_requests")

MAX_USES_EXCEEDED("max_uses_exceeded")

UNAVAILABLE("unavailable")

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

class BetaWebFetchToolResultErrorBlockParam:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

URL_TOO_LONG("url_too_long")

URL_NOT_ALLOWED("url_not_allowed")

URL_NOT_ACCESSIBLE("url_not_accessible")

UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")

TOO_MANY_REQUESTS("too_many_requests")

MAX_USES_EXCEEDED("max_uses_exceeded")

UNAVAILABLE("unavailable")

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

enum BetaWebFetchToolResultErrorCode:

INVALID_TOOL_INPUT("invalid_tool_input")

URL_TOO_LONG("url_too_long")

URL_NOT_ALLOWED("url_not_allowed")

URL_NOT_ACCESSIBLE("url_not_accessible")

UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")

TOO_MANY_REQUESTS("too_many_requests")

MAX_USES_EXCEEDED("max_uses_exceeded")

UNAVAILABLE("unavailable")

class BetaWebSearchResultBlock:

String encryptedContent

Optional<String> pageAge

String title

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

String url

class BetaWebSearchResultBlockParam:

String encryptedContent

String title

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

String url

Optional<String> pageAge

class BetaWebSearchTool20250305:

JsonValue; name

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

Accepts one of the following:

WEB_SEARCH("web_search")

JsonValue; type

Accepts one of the following:

WEB_SEARCH_20250305("web_search_20250305")

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.

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

Optional<Long> maxUses

Maximum number of times the tool can be used in the API request.

exclusiveMinimum0

Optional<UserLocation> userLocation

Parameters for the user's location. Used to provide more relevant search results.

JsonValue; type

Accepts one of the following:

APPROXIMATE("approximate")

Optional<String> city

The city of the user.

maxLength255

minLength1

Optional<String> country

The two letter ISO country code of the user.

maxLength2

minLength2

Optional<String> region

The region of the user.

maxLength255

minLength1

Optional<String> timezone

The IANA timezone of the user.

maxLength255

minLength1

class BetaWebSearchToolRequestError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

MAX_USES_EXCEEDED("max_uses_exceeded")

TOO_MANY_REQUESTS("too_many_requests")

QUERY_TOO_LONG("query_too_long")

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

class BetaWebSearchToolResultBlock:

Accepts one of the following:

class BetaWebSearchToolResultError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

MAX_USES_EXCEEDED("max_uses_exceeded")

TOO_MANY_REQUESTS("too_many_requests")

QUERY_TOO_LONG("query_too_long")

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

String encryptedContent

Optional<String> pageAge

String title

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

String url

String toolUseId

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT("web_search_tool_result")

class BetaWebSearchToolResultBlockContent:

class BetaWebSearchToolResultError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

MAX_USES_EXCEEDED("max_uses_exceeded")

TOO_MANY_REQUESTS("too_many_requests")

QUERY_TOO_LONG("query_too_long")

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

String encryptedContent

Optional<String> pageAge

String title

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

String url

class BetaWebSearchToolResultBlockParam:

BetaWebSearchToolResultBlockParamContent content

Accepts one of the following:

String encryptedContent

String title

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

String url

Optional<String> pageAge

class BetaWebSearchToolRequestError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

MAX_USES_EXCEEDED("max_uses_exceeded")

TOO_MANY_REQUESTS("too_many_requests")

QUERY_TOO_LONG("query_too_long")

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

String toolUseId

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT("web_search_tool_result")

Optional<BetaCacheControlEphemeral> cacheControl

Create a cache control breakpoint at this content block.

JsonValue; type

Accepts one of the following:

EPHEMERAL("ephemeral")

Optional<Ttl> ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

TTL_5M("5m")

TTL_1H("1h")

class BetaWebSearchToolResultBlockParamContent:

String encryptedContent

String title

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

String url

Optional<String> pageAge

class BetaWebSearchToolRequestError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

MAX_USES_EXCEEDED("max_uses_exceeded")

TOO_MANY_REQUESTS("too_many_requests")

QUERY_TOO_LONG("query_too_long")

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

class BetaWebSearchToolResultError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

MAX_USES_EXCEEDED("max_uses_exceeded")

TOO_MANY_REQUESTS("too_many_requests")

QUERY_TOO_LONG("query_too_long")

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

enum BetaWebSearchToolResultErrorCode:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

MAX_USES_EXCEEDED("max_uses_exceeded")

TOO_MANY_REQUESTS("too_many_requests")

QUERY_TOO_LONG("query_too_long")

BetaMessagesBatches

Cancel a Message Batch

BetaMessageBatch beta().messages().batches().cancel(, )

post/v1/messages/batches/{message_batch_id}/cancel?beta=true

Create a Message Batch

BetaMessageBatch beta().messages().batches().create(, )

post/v1/messages/batches?beta=true

Delete a Message Batch

BetaDeletedMessageBatch beta().messages().batches().delete(, )

delete/v1/messages/batches/{message_batch_id}?beta=true

List Message Batches

BatchListPage beta().messages().batches().list(, )

get/v1/messages/batches?beta=true

Retrieve Message Batch results

BetaMessageBatchIndividualResponse beta().messages().batches().resultsStreaming(, )

get/v1/messages/batches/{message_batch_id}/results?beta=true

Retrieve a Message Batch

BetaMessageBatch beta().messages().batches().retrieve(, )

get/v1/messages/batches/{message_batch_id}?beta=true

ModelsExpand Collapse

class BetaDeletedMessageBatch:

String id

ID of the Message Batch.

JsonValue; type

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

Accepts one of the following:

MESSAGE_BATCH_DELETED("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.

formatdate-time

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.

formatdate-time

LocalDateTime createdAt

RFC 3339 datetime string representing the time at which the Message Batch was created.

formatdate-time

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.

formatdate-time

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.

formatdate-time

ProcessingStatus processingStatus

Processing status of the Message Batch.

Accepts one of the following:

IN_PROGRESS("in_progress")

CANCELING("canceling")

ENDED("ended")

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

Object type.

For Message Batches, this is always "message_batch".

Accepts one of the following:

MESSAGE_BATCH("message_batch")

class BetaMessageBatchCanceledResult:

JsonValue; type

Accepts one of the following:

CANCELED("canceled")

class BetaMessageBatchErroredResult:

BetaErrorResponse error

BetaError error

Accepts one of the following:

class BetaInvalidRequestError:

String message

JsonValue; type

Accepts one of the following:

INVALID_REQUEST_ERROR("invalid_request_error")

class BetaAuthenticationError:

String message

JsonValue; type

Accepts one of the following:

AUTHENTICATION_ERROR("authentication_error")

class BetaBillingError:

String message

JsonValue; type

Accepts one of the following:

BILLING_ERROR("billing_error")

class BetaPermissionError:

String message

JsonValue; type

Accepts one of the following:

PERMISSION_ERROR("permission_error")

class BetaNotFoundError:

String message

JsonValue; type

Accepts one of the following:

NOT_FOUND_ERROR("not_found_error")

class BetaRateLimitError:

String message

JsonValue; type

Accepts one of the following:

RATE_LIMIT_ERROR("rate_limit_error")

class BetaGatewayTimeoutError:

String message

JsonValue; type

Accepts one of the following:

TIMEOUT_ERROR("timeout_error")

class BetaApiError:

String message

JsonValue; type

Accepts one of the following:

API_ERROR("api_error")

class BetaOverloadedError:

String message

JsonValue; type

Accepts one of the following:

OVERLOADED_ERROR("overloaded_error")

Optional<String> requestId

JsonValue; type

Accepts one of the following:

ERROR("error")

JsonValue; type

Accepts one of the following:

ERRORED("errored")

class BetaMessageBatchExpiredResult:

JsonValue; type

Accepts one of the following:

EXPIRED("expired")

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.

Accepts one of the following:

class BetaMessageBatchSucceededResult:

BetaMessage message

String id

Unique object identifier.

The format and length of IDs may change over time.

Optional<BetaContainer> container

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.

formatdate-time

Optional<List<BetaSkill>> skills

Skills loaded in the container

String skillId

Skill ID

maxLength64

minLength1

Type type

Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)

Accepts one of the following:

ANTHROPIC("anthropic")

CUSTOM("custom")

String version

Skill version or 'latest' for most recent version

maxLength64

minLength1

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)"}]

Accepts one of the following:

class BetaTextBlock:

Optional<List<BetaTextCitation>> citations

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endCharIndex

Optional<String> fileId

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endPageNumber

Optional<String> fileId

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endBlockIndex

Optional<String> fileId

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

class BetaCitationSearchResultLocation:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

String text

maxLength5000000

minLength0

JsonValue; type

Accepts one of the following:

TEXT("text")

class BetaThinkingBlock:

String signature

String thinking

JsonValue; type

Accepts one of the following:

THINKING("thinking")

class BetaRedactedThinkingBlock:

String data

JsonValue; type

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaToolUseBlock:

String id

Input input

String name

minLength1

JsonValue; type

Accepts one of the following:

TOOL_USE("tool_use")

class BetaServerToolUseBlock:

String id

Input input

Name name

Accepts one of the following:

WEB_SEARCH("web_search")

WEB_FETCH("web_fetch")

CODE_EXECUTION("code_execution")

BASH_CODE_EXECUTION("bash_code_execution")

TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")

JsonValue; type

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

class BetaWebSearchToolResultBlock:

Accepts one of the following:

class BetaWebSearchToolResultError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

MAX_USES_EXCEEDED("max_uses_exceeded")

TOO_MANY_REQUESTS("too_many_requests")

QUERY_TOO_LONG("query_too_long")

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

String encryptedContent

Optional<String> pageAge

String title

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

String url

String toolUseId

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT("web_search_tool_result")

class BetaWebFetchToolResultBlock:

Content content

Accepts one of the following:

class BetaWebFetchToolResultErrorBlock:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

URL_TOO_LONG("url_too_long")

URL_NOT_ALLOWED("url_not_allowed")

URL_NOT_ACCESSIBLE("url_not_accessible")

UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")

TOO_MANY_REQUESTS("too_many_requests")

MAX_USES_EXCEEDED("max_uses_exceeded")

UNAVAILABLE("unavailable")

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

class BetaWebFetchBlock:

BetaDocumentBlock content

Optional<BetaCitationConfig> citations

Citation configuration for the document

boolean enabled

Source source

Accepts one of the following:

class BetaBase64PdfSource:

String data

formatbyte

JsonValue; mediaType

Accepts one of the following:

APPLICATION_PDF("application/pdf")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

String data

JsonValue; mediaType

Accepts one of the following:

TEXT_PLAIN("text/plain")

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<String> title

The title of the document

JsonValue; type

Accepts one of the following:

DOCUMENT("document")

Optional<String> retrievedAt

ISO 8601 timestamp when the content was retrieved

JsonValue; type

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

String url

Fetched content URL

String toolUseId

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT("web_fetch_tool_result")

class BetaCodeExecutionToolResultBlock:

Accepts one of the following:

class BetaCodeExecutionToolResultError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlock:

List<BetaCodeExecutionOutputBlock> content

String fileId

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

long returnCode

String stderr

String stdout

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

String toolUseId

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT("code_execution_tool_result")

class BetaBashCodeExecutionToolResultBlock:

Content content

Accepts one of the following:

class BetaBashCodeExecutionToolResultError:

ErrorCode errorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

OUTPUT_FILE_TOO_LARGE("output_file_too_large")

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")

class BetaBashCodeExecutionResultBlock:

List<BetaBashCodeExecutionOutputBlock> content

String fileId

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")

long returnCode

String stderr

String stdout

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")

String toolUseId

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT("bash_code_execution_tool_result")

class BetaTextEditorCodeExecutionToolResultBlock:

Content content

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultError:

ErrorCode errorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

FILE_NOT_FOUND("file_not_found")

Optional<String> errorMessage

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

class BetaTextEditorCodeExecutionViewResultBlock:

String content

FileType fileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

Optional<Long> numLines

Optional<Long> startLine

Optional<Long> totalLines

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

class BetaTextEditorCodeExecutionCreateResultBlock:

boolean isFileUpdate

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlock:

Optional<List<String>> lines

Optional<Long> newLines

Optional<Long> newStart

Optional<Long> oldLines

Optional<Long> oldStart

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

String toolUseId

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")

class BetaMcpToolUseBlock:

String id

Input input

String name

The name of the MCP tool

String serverName

The name of the MCP server

JsonValue; type

Accepts one of the following:

MCP_TOOL_USE("mcp_tool_use")

class BetaMcpToolResultBlock:

Content content

Accepts one of the following:

String

List<BetaTextBlock>

Optional<List<BetaTextCitation>> citations

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endCharIndex

Optional<String> fileId

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endPageNumber

Optional<String> fileId

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endBlockIndex

Optional<String> fileId

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

class BetaCitationSearchResultLocation:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

String text

maxLength5000000

minLength0

JsonValue; type

Accepts one of the following:

TEXT("text")

boolean isError

String toolUseId

JsonValue; type

Accepts one of the following:

MCP_TOOL_RESULT("mcp_tool_result")

class BetaContainerUploadBlock:

Response model for a file uploaded to the container.

String fileId

JsonValue; type

Accepts one of the following:

CONTAINER_UPLOAD("container_upload")

Optional<BetaContextManagementResponse> contextManagement

Context management response.

Information about context management strategies applied during the request.

List<AppliedEdit> appliedEdits

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse:

long clearedInputTokens

Number of input tokens cleared by this edit.

minimum0

long clearedToolUses

Number of tool uses that were cleared.

minimum0

JsonValue; type

The type of context management edit applied.

Accepts one of the following:

CLEAR_TOOL_USES_20250919("clear_tool_uses_20250919")

class BetaClearThinking20251015EditResponse:

long clearedInputTokens

Number of input tokens cleared by this edit.

minimum0

long clearedThinkingTurns

Number of thinking turns that were cleared.

minimum0

JsonValue; type

The type of context management edit applied.

Accepts one of the following:

CLEAR_THINKING_20251015("clear_thinking_20251015")

Model model

The model that will complete your prompt.

See models for additional details and options.

Accepts one of the following:

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

Conversational role of the generated message.

This will always be "assistant".

Accepts one of the following:

ASSISTANT("assistant")

Optional<BetaStopReason> stopReason

The reason that we stopped.

This may be one the following values:

"end_turn": the model reached a natural stopping point
"max_tokens": we exceeded the requested max_tokens or the model's maximum
"stop_sequence": one of your provided custom stop_sequences was generated
"tool_use": the model invoked one or more tools
"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue.
"refusal": when streaming classifiers intervene to handle potential policy violations

In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.

Accepts one of the following:

END_TURN("end_turn")

MAX_TOKENS("max_tokens")

STOP_SEQUENCE("stop_sequence")

TOOL_USE("tool_use")

PAUSE_TURN("pause_turn")

REFUSAL("refusal")

MODEL_CONTEXT_WINDOW_EXCEEDED("model_context_window_exceeded")

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

Object type.

For Messages, this is always "message".

Accepts one of the following:

MESSAGE("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.

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<BetaCacheCreation> cacheCreation

Breakdown of cached tokens by TTL

long ephemeral1hInputTokens

The number of input tokens used to create the 1 hour cache entry.

minimum0

long ephemeral5mInputTokens

The number of input tokens used to create the 5 minute cache entry.

minimum0

Optional<Long> cacheCreationInputTokens

The number of input tokens used to create the cache entry.

minimum0

Optional<Long> cacheReadInputTokens

The number of input tokens read from the cache.

minimum0

long inputTokens

The number of input tokens which were used.

minimum0

long outputTokens

The number of output tokens which were used.

minimum0

Optional<BetaServerToolUsage> serverToolUse

The number of server tool requests.

long webFetchRequests

The number of web fetch tool requests.

minimum0

long webSearchRequests

The number of web search tool requests.

minimum0

Optional<ServiceTier> serviceTier

If the request used the priority, standard, or batch tier.

Accepts one of the following:

STANDARD("standard")

PRIORITY("priority")

BATCH("batch")

JsonValue; type

Accepts one of the following:

SUCCEEDED("succeeded")

class BetaMessageBatchErroredResult:

BetaErrorResponse error

BetaError error

Accepts one of the following:

class BetaInvalidRequestError:

String message

JsonValue; type

Accepts one of the following:

INVALID_REQUEST_ERROR("invalid_request_error")

class BetaAuthenticationError:

String message

JsonValue; type

Accepts one of the following:

AUTHENTICATION_ERROR("authentication_error")

class BetaBillingError:

String message

JsonValue; type

Accepts one of the following:

BILLING_ERROR("billing_error")

class BetaPermissionError:

String message

JsonValue; type

Accepts one of the following:

PERMISSION_ERROR("permission_error")

class BetaNotFoundError:

String message

JsonValue; type

Accepts one of the following:

NOT_FOUND_ERROR("not_found_error")

class BetaRateLimitError:

String message

JsonValue; type

Accepts one of the following:

RATE_LIMIT_ERROR("rate_limit_error")

class BetaGatewayTimeoutError:

String message

JsonValue; type

Accepts one of the following:

TIMEOUT_ERROR("timeout_error")

class BetaApiError:

String message

JsonValue; type

Accepts one of the following:

API_ERROR("api_error")

class BetaOverloadedError:

String message

JsonValue; type

Accepts one of the following:

OVERLOADED_ERROR("overloaded_error")

Optional<String> requestId

JsonValue; type

Accepts one of the following:

ERROR("error")

JsonValue; type

Accepts one of the following:

ERRORED("errored")

class BetaMessageBatchCanceledResult:

JsonValue; type

Accepts one of the following:

CANCELED("canceled")

class BetaMessageBatchExpiredResult:

JsonValue; type

Accepts one of the following:

EXPIRED("expired")

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:

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.

Optional<BetaContainer> container

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.

formatdate-time

Optional<List<BetaSkill>> skills

Skills loaded in the container

String skillId

Skill ID

maxLength64

minLength1

Type type

Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)

Accepts one of the following:

ANTHROPIC("anthropic")

CUSTOM("custom")

String version

Skill version or 'latest' for most recent version

maxLength64

minLength1

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)"}]

Accepts one of the following:

class BetaTextBlock:

Optional<List<BetaTextCitation>> citations

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endCharIndex

Optional<String> fileId

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endPageNumber

Optional<String> fileId

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endBlockIndex

Optional<String> fileId

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

class BetaCitationSearchResultLocation:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

String text

maxLength5000000

minLength0

JsonValue; type

Accepts one of the following:

TEXT("text")

class BetaThinkingBlock:

String signature

String thinking

JsonValue; type

Accepts one of the following:

THINKING("thinking")

class BetaRedactedThinkingBlock:

String data

JsonValue; type

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaToolUseBlock:

String id

Input input

String name

minLength1

JsonValue; type

Accepts one of the following:

TOOL_USE("tool_use")

class BetaServerToolUseBlock:

String id

Input input

Name name

Accepts one of the following:

WEB_SEARCH("web_search")

WEB_FETCH("web_fetch")

CODE_EXECUTION("code_execution")

BASH_CODE_EXECUTION("bash_code_execution")

TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")

JsonValue; type

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

class BetaWebSearchToolResultBlock:

Accepts one of the following:

class BetaWebSearchToolResultError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

MAX_USES_EXCEEDED("max_uses_exceeded")

TOO_MANY_REQUESTS("too_many_requests")

QUERY_TOO_LONG("query_too_long")

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

String encryptedContent

Optional<String> pageAge

String title

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

String url

String toolUseId

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT("web_search_tool_result")

class BetaWebFetchToolResultBlock:

Content content

Accepts one of the following:

class BetaWebFetchToolResultErrorBlock:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

URL_TOO_LONG("url_too_long")

URL_NOT_ALLOWED("url_not_allowed")

URL_NOT_ACCESSIBLE("url_not_accessible")

UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")

TOO_MANY_REQUESTS("too_many_requests")

MAX_USES_EXCEEDED("max_uses_exceeded")

UNAVAILABLE("unavailable")

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

class BetaWebFetchBlock:

BetaDocumentBlock content

Optional<BetaCitationConfig> citations

Citation configuration for the document

boolean enabled

Source source

Accepts one of the following:

class BetaBase64PdfSource:

String data

formatbyte

JsonValue; mediaType

Accepts one of the following:

APPLICATION_PDF("application/pdf")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

String data

JsonValue; mediaType

Accepts one of the following:

TEXT_PLAIN("text/plain")

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<String> title

The title of the document

JsonValue; type

Accepts one of the following:

DOCUMENT("document")

Optional<String> retrievedAt

ISO 8601 timestamp when the content was retrieved

JsonValue; type

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

String url

Fetched content URL

String toolUseId

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT("web_fetch_tool_result")

class BetaCodeExecutionToolResultBlock:

Accepts one of the following:

class BetaCodeExecutionToolResultError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlock:

List<BetaCodeExecutionOutputBlock> content

String fileId

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

long returnCode

String stderr

String stdout

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

String toolUseId

JsonValue; type

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT("code_execution_tool_result")

class BetaBashCodeExecutionToolResultBlock:

Content content

Accepts one of the following:

class BetaBashCodeExecutionToolResultError:

ErrorCode errorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

OUTPUT_FILE_TOO_LARGE("output_file_too_large")

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")

class BetaBashCodeExecutionResultBlock:

List<BetaBashCodeExecutionOutputBlock> content

String fileId

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")

long returnCode

String stderr

String stdout

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")

String toolUseId

JsonValue; type

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT("bash_code_execution_tool_result")

class BetaTextEditorCodeExecutionToolResultBlock:

Content content

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultError:

ErrorCode errorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

FILE_NOT_FOUND("file_not_found")

Optional<String> errorMessage

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

class BetaTextEditorCodeExecutionViewResultBlock:

String content

FileType fileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

Optional<Long> numLines

Optional<Long> startLine

Optional<Long> totalLines

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

class BetaTextEditorCodeExecutionCreateResultBlock:

boolean isFileUpdate

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlock:

Optional<List<String>> lines

Optional<Long> newLines

Optional<Long> newStart

Optional<Long> oldLines

Optional<Long> oldStart

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

String toolUseId

JsonValue; type

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")

class BetaMcpToolUseBlock:

String id

Input input

String name

The name of the MCP tool

String serverName

The name of the MCP server

JsonValue; type

Accepts one of the following:

MCP_TOOL_USE("mcp_tool_use")

class BetaMcpToolResultBlock:

Content content

Accepts one of the following:

String

List<BetaTextBlock>

Optional<List<BetaTextCitation>> citations

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endCharIndex

Optional<String> fileId

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endPageNumber

Optional<String> fileId

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endBlockIndex

Optional<String> fileId

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

class BetaCitationSearchResultLocation:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

String text

maxLength5000000

minLength0

JsonValue; type

Accepts one of the following:

TEXT("text")

boolean isError

String toolUseId

JsonValue; type

Accepts one of the following:

MCP_TOOL_RESULT("mcp_tool_result")

class BetaContainerUploadBlock:

Response model for a file uploaded to the container.

String fileId

JsonValue; type

Accepts one of the following:

CONTAINER_UPLOAD("container_upload")

Optional<BetaContextManagementResponse> contextManagement

Context management response.

Information about context management strategies applied during the request.

List<AppliedEdit> appliedEdits

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse:

long clearedInputTokens

Number of input tokens cleared by this edit.

minimum0

long clearedToolUses

Number of tool uses that were cleared.

minimum0

JsonValue; type

The type of context management edit applied.

Accepts one of the following:

CLEAR_TOOL_USES_20250919("clear_tool_uses_20250919")

class BetaClearThinking20251015EditResponse:

long clearedInputTokens

Number of input tokens cleared by this edit.

minimum0

long clearedThinkingTurns

Number of thinking turns that were cleared.

minimum0

JsonValue; type

The type of context management edit applied.

Accepts one of the following:

CLEAR_THINKING_20251015("clear_thinking_20251015")

Model model

The model that will complete your prompt.

See models for additional details and options.

Accepts one of the following:

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

Conversational role of the generated message.

This will always be "assistant".

Accepts one of the following:

ASSISTANT("assistant")

Optional<BetaStopReason> stopReason

The reason that we stopped.

This may be one the following values:

"end_turn": the model reached a natural stopping point
"max_tokens": we exceeded the requested max_tokens or the model's maximum
"stop_sequence": one of your provided custom stop_sequences was generated
"tool_use": the model invoked one or more tools
"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue.
"refusal": when streaming classifiers intervene to handle potential policy violations

In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.

Accepts one of the following:

END_TURN("end_turn")

MAX_TOKENS("max_tokens")

STOP_SEQUENCE("stop_sequence")

TOOL_USE("tool_use")

PAUSE_TURN("pause_turn")

REFUSAL("refusal")

MODEL_CONTEXT_WINDOW_EXCEEDED("model_context_window_exceeded")

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

Object type.

For Messages, this is always "message".

Accepts one of the following:

MESSAGE("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.

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<BetaCacheCreation> cacheCreation

Breakdown of cached tokens by TTL

long ephemeral1hInputTokens

The number of input tokens used to create the 1 hour cache entry.

minimum0

long ephemeral5mInputTokens

The number of input tokens used to create the 5 minute cache entry.

minimum0

Optional<Long> cacheCreationInputTokens

The number of input tokens used to create the cache entry.

minimum0

Optional<Long> cacheReadInputTokens

The number of input tokens read from the cache.

minimum0

long inputTokens

The number of input tokens which were used.

minimum0

long outputTokens

The number of output tokens which were used.

minimum0

Optional<BetaServerToolUsage> serverToolUse

The number of server tool requests.

long webFetchRequests

The number of web fetch tool requests.

minimum0

long webSearchRequests

The number of web search tool requests.

minimum0

Optional<ServiceTier> serviceTier

If the request used the priority, standard, or batch tier.

Accepts one of the following:

STANDARD("standard")

PRIORITY("priority")

BATCH("batch")

JsonValue; type

Accepts one of the following:

SUCCEEDED("succeeded")

class BetaMessageBatchErroredResult:

BetaErrorResponse error

BetaError error

Accepts one of the following:

class BetaInvalidRequestError:

String message

JsonValue; type

Accepts one of the following:

INVALID_REQUEST_ERROR("invalid_request_error")

class BetaAuthenticationError:

String message

JsonValue; type

Accepts one of the following:

AUTHENTICATION_ERROR("authentication_error")

class BetaBillingError:

String message

JsonValue; type

Accepts one of the following:

BILLING_ERROR("billing_error")

class BetaPermissionError:

String message

JsonValue; type

Accepts one of the following:

PERMISSION_ERROR("permission_error")

class BetaNotFoundError:

String message

JsonValue; type

Accepts one of the following:

NOT_FOUND_ERROR("not_found_error")

class BetaRateLimitError:

String message

JsonValue; type

Accepts one of the following:

RATE_LIMIT_ERROR("rate_limit_error")

class BetaGatewayTimeoutError:

String message

JsonValue; type

Accepts one of the following:

TIMEOUT_ERROR("timeout_error")

class BetaApiError:

String message

JsonValue; type

Accepts one of the following:

API_ERROR("api_error")

class BetaOverloadedError:

String message

JsonValue; type

Accepts one of the following:

OVERLOADED_ERROR("overloaded_error")

Optional<String> requestId

JsonValue; type

Accepts one of the following:

ERROR("error")

JsonValue; type

Accepts one of the following:

ERRORED("errored")

class BetaMessageBatchCanceledResult:

JsonValue; type

Accepts one of the following:

CANCELED("canceled")

class BetaMessageBatchExpiredResult:

JsonValue; type

Accepts one of the following:

EXPIRED("expired")

class BetaMessageBatchSucceededResult:

BetaMessage message

String id

Unique object identifier.

The format and length of IDs may change over time.

Optional<BetaContainer> container

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.

formatdate-time

Optional<List<BetaSkill>> skills

Skills loaded in the container

String skillId

Skill ID

maxLength64

minLength1

Type type

Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)

Accepts one of the following:

ANTHROPIC("anthropic")

CUSTOM("custom")

String version

Skill version or 'latest' for most recent version

maxLength64

minLength1

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)"}]

Accepts one of the following:

class BetaTextBlock:

Optional<List<BetaTextCitation>> citations

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endCharIndex

Optional<String> fileId

long startCharIndex

minimum0

JsonValue; type

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endPageNumber

Optional<String> fileId

long startPageNumber

minimum1

JsonValue; type

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

String citedText

long documentIndex

minimum0

Optional<String> documentTitle

long endBlockIndex

Optional<String> fileId

long startBlockIndex

minimum0

JsonValue; type

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

String citedText

String encryptedIndex

Optional<String> title

maxLength512

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

String url

class BetaCitationSearchResultLocation:

String citedText

long endBlockIndex

long searchResultIndex

minimum0

String source

long startBlockIndex

minimum0

Optional<String> title

JsonValue; type

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

String text

maxLength5000000

minLength0

JsonValue; type

Accepts one of the following:

TEXT("text")

class BetaThinkingBlock:

String signature

String thinking

JsonValue; type

Accepts one of the following:

THINKING("thinking")

class BetaRedactedThinkingBlock:

String data

JsonValue; type

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaToolUseBlock:

String id

Input input

String name

minLength1

JsonValue; type

Accepts one of the following:

TOOL_USE("tool_use")

class BetaServerToolUseBlock:

String id

Input input

Name name

Accepts one of the following:

WEB_SEARCH("web_search")

WEB_FETCH("web_fetch")

CODE_EXECUTION("code_execution")

BASH_CODE_EXECUTION("bash_code_execution")

TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")

JsonValue; type

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

class BetaWebSearchToolResultBlock:

Accepts one of the following:

class BetaWebSearchToolResultError:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

MAX_USES_EXCEEDED("max_uses_exceeded")

TOO_MANY_REQUESTS("too_many_requests")

QUERY_TOO_LONG("query_too_long")

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

String encryptedContent

Optional<String> pageAge

String title

JsonValue; type

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

String url

String toolUseId

JsonValue; type

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT("web_search_tool_result")

class BetaWebFetchToolResultBlock:

Content content

Accepts one of the following:

class BetaWebFetchToolResultErrorBlock:

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

URL_TOO_LONG("url_too_long")

URL_NOT_ALLOWED("url_not_allowed")

URL_NOT_ACCESSIBLE("url_not_accessible")

UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")

TOO_MANY_REQUESTS("too_many_requests")

MAX_USES_EXCEEDED("max_uses_exceeded")

UNAVAILABLE("unavailable")

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

class BetaWebFetchBlock:

BetaDocumentBlock content

Optional<BetaCitationConfig> citations

Citation configuration for the document

boolean enabled

Source source

Accepts one of the following:

class BetaBase64PdfSource:

String data

formatbyte

JsonValue; mediaType

Accepts one of the following:

APPLICATION_PDF("application/pdf")

JsonValue; type

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

String data

JsonValue; mediaType

Accepts one of the following:

TEXT_PLAIN("text/plain")

JsonValue; type

Accepts one of the following:

TEXT("text")

Optional<String> title

The title of the document

JsonValue; type

Accepts one of the following:

DOCUMENT("document")

Optional<String> retrievedAt

ISO 8601 timestamp when the content was retrieved

JsonValue; type

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

String url

Fetched content URL

String toolUseId

JsonValue; type

Accepts one of the following:

WEB_FETCH_TOOL_RESULT("web_fetch_tool_result")

class BetaCodeExecutionToolResultBlock:

Accepts one of the following:

class BetaCodeExecutionToolResultError: