Messages

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

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlock:

content: List<BetaCodeExecutionOutputBlock>

fileId: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlock:

content: List<BetaCodeExecutionOutputBlock>

fileId: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

class BetaCodeExecutionToolResultBlockParam:

content: BetaCodeExecutionToolResultBlockParamContent

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

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlockParam:

content: List<BetaCodeExecutionOutputBlockParam>

fileId: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

toolUseId: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT("code_execution_tool_result")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlockParam:

content: List<BetaCodeExecutionOutputBlockParam>

fileId: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

enum class 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")

type: JsonValue;

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)

id: String

Identifier for the container used in this request

expiresAt: LocalDateTime

The time at which the container will expire.

formatdate-time

skills: Optional<List<BetaSkill>>

Skills loaded in the container

skillId: String

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

version: String

Skill version or 'latest' for most recent version

maxLength64

minLength1

class BetaContainerParams:

Container parameters with skills to be loaded.

id: Optional<String>

Container id

skills: Optional<List<BetaSkillParams>>

List of skills to load in the container

skillId: String

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

version: Optional<String>

Skill version or 'latest' for most recent version

maxLength64

minLength1

class BetaContainerUploadBlock:

Response model for a file uploaded to the container.

fileId: String

type: JsonValue;

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.

fileId: String

type: JsonValue;

Accepts one of the following:

CONTAINER_UPLOAD("container_upload")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

citations: Optional<List<BetaTextCitation>>

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:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

text: String

maxLength5000000

minLength0

type: JsonValue;

Accepts one of the following:

TEXT("text")

class BetaThinkingBlock:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class BetaRedactedThinkingBlock:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaToolUseBlock:

id: String

input: Input

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

class BetaServerToolUseBlock:

id: String

input: Input

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

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

encryptedContent: String

pageAge: Optional<String>

title: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

url: String

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

class BetaWebFetchBlock:

content: BetaDocumentBlock

citations: Optional<BetaCitationConfig>

Citation configuration for the document

enabled: Boolean

source: Source

Accepts one of the following:

class BetaBase64PdfSource:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

title: Optional<String>

The title of the document

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

retrievedAt: Optional<String>

ISO 8601 timestamp when the content was retrieved

type: JsonValue;

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

url: String

Fetched content URL

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlock:

content: List<BetaCodeExecutionOutputBlock>

fileId: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")

class BetaBashCodeExecutionResultBlock:

content: List<BetaBashCodeExecutionOutputBlock>

fileId: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")

toolUseId: String

type: JsonValue;

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

errorMessage: Optional<String>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

class BetaTextEditorCodeExecutionViewResultBlock:

content: String

fileType: FileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

numLines: Optional<Long>

startLine: Optional<Long>

totalLines: Optional<Long>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

class BetaTextEditorCodeExecutionCreateResultBlock:

isFileUpdate: Boolean

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlock:

lines: Optional<List<String>>

newLines: Optional<Long>

newStart: Optional<Long>

oldLines: Optional<Long>

oldStart: Optional<Long>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

toolUseId: String

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")

class BetaMcpToolUseBlock:

id: String

input: Input

The name of the MCP tool

serverName: String

The name of the MCP server

type: JsonValue;

Accepts one of the following:

MCP_TOOL_USE("mcp_tool_use")

class BetaMcpToolResultBlock:

content: Content

Accepts one of the following:

String

List<BetaTextBlock>

citations: Optional<List<BetaTextCitation>>

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

text: String

maxLength5000000

minLength0

type: JsonValue;

Accepts one of the following:

TEXT("text")

isError: Boolean

toolUseId: String

type: JsonValue;

Accepts one of the following:

MCP_TOOL_RESULT("mcp_tool_result")

class BetaContainerUploadBlock:

Response model for a file uploaded to the container.

fileId: String

type: JsonValue;

Accepts one of the following:

CONTAINER_UPLOAD("container_upload")

class BetaContentBlockParam:

Regular text content.

class BetaTextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<List<BetaTextCitationParam>>

Accepts one of the following:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

source: Source

Accepts one of the following:

class BetaBase64ImageSource:

data: String

formatbyte

mediaType: MediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileImageSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

class BetaContentBlockSource:

content: Content

Accepts one of the following:

String

Accepts one of the following:

class BetaTextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<List<BetaTextCitationParam>>

Accepts one of the following:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

source: Source

Accepts one of the following:

class BetaBase64ImageSource:

data: String

formatbyte

mediaType: MediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileImageSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

type: JsonValue;

Accepts one of the following:

CONTENT("content")

class BetaUrlPdfSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileDocumentSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<BetaCitationsConfigParam>

enabled: Optional<Boolean>

context: Optional<String>

minLength1

title: Optional<String>

maxLength500

minLength1

class BetaSearchResultBlockParam:

content: List<BetaTextBlockParam>

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<List<BetaTextCitationParam>>

Accepts one of the following:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

source: String

title: String

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT("search_result")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<BetaCitationsConfigParam>

enabled: Optional<Boolean>

class BetaThinkingBlockParam:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class BetaRedactedThinkingBlockParam:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaToolUseBlockParam:

id: String

input: Input

maxLength200

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

toolUseId: String

type: JsonValue;

Accepts one of the following:

TOOL_RESULT("tool_result")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

content: Optional<Content>

Accepts one of the following:

String

List<Block>

Accepts one of the following:

class BetaTextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<List<BetaTextCitationParam>>

Accepts one of the following:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

source: Source

Accepts one of the following:

class BetaBase64ImageSource:

data: String

formatbyte

mediaType: MediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileImageSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

content: List<BetaTextBlockParam>

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<List<BetaTextCitationParam>>

Accepts one of the following:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

source: String

title: String

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT("search_result")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<BetaCitationsConfigParam>

enabled: Optional<Boolean>

class BetaRequestDocumentBlock:

source: Source

Accepts one of the following:

class BetaBase64PdfSource:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

class BetaContentBlockSource:

content: Content

Accepts one of the following:

String

Accepts one of the following:

class BetaTextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<List<BetaTextCitationParam>>

Accepts one of the following:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

source: Source

Accepts one of the following:

class BetaBase64ImageSource:

data: String

formatbyte

mediaType: MediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileImageSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

type: JsonValue;

Accepts one of the following:

CONTENT("content")

class BetaUrlPdfSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileDocumentSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<BetaCitationsConfigParam>

enabled: Optional<Boolean>

context: Optional<String>

minLength1

title: Optional<String>

maxLength500

minLength1

isError: Optional<Boolean>

class BetaServerToolUseBlockParam:

id: String

input: Input

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

type: JsonValue;

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

content: BetaWebSearchToolResultBlockParamContent

Accepts one of the following:

encryptedContent: String

title: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

url: String

pageAge: Optional<String>

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

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

toolUseId: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT("web_search_tool_result")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

type: JsonValue;

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:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

class BetaContentBlockSource:

content: Content

Accepts one of the following:

String

Accepts one of the following:

class BetaTextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<List<BetaTextCitationParam>>

Accepts one of the following:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

source: Source

Accepts one of the following:

class BetaBase64ImageSource:

data: String

formatbyte

mediaType: MediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileImageSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

type: JsonValue;

Accepts one of the following:

CONTENT("content")

class BetaUrlPdfSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileDocumentSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<BetaCitationsConfigParam>

enabled: Optional<Boolean>

context: Optional<String>

minLength1

title: Optional<String>

maxLength500

minLength1

type: JsonValue;

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

url: String

Fetched content URL

retrievedAt: Optional<String>

ISO 8601 timestamp when the content was retrieved

toolUseId: String

type: JsonValue;

Accepts one of the following:

WEB_FETCH_TOOL_RESULT("web_fetch_tool_result")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

content: BetaCodeExecutionToolResultBlockParamContent

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

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlockParam:

content: List<BetaCodeExecutionOutputBlockParam>

fileId: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

toolUseId: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT("code_execution_tool_result")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")

class BetaBashCodeExecutionResultBlockParam:

content: List<BetaBashCodeExecutionOutputBlockParam>

fileId: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")

toolUseId: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT("bash_code_execution_tool_result")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

errorMessage: Optional<String>

class BetaTextEditorCodeExecutionViewResultBlockParam:

content: String

fileType: FileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

numLines: Optional<Long>

startLine: Optional<Long>

totalLines: Optional<Long>

class BetaTextEditorCodeExecutionCreateResultBlockParam:

isFileUpdate: Boolean

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlockParam:

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

lines: Optional<List<String>>

newLines: Optional<Long>

newStart: Optional<Long>

oldLines: Optional<Long>

oldStart: Optional<Long>

toolUseId: String

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

id: String

input: Input

serverName: String

The name of the MCP server

type: JsonValue;

Accepts one of the following:

MCP_TOOL_USE("mcp_tool_use")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

toolUseId: String

type: JsonValue;

Accepts one of the following:

MCP_TOOL_RESULT("mcp_tool_result")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

content: Optional<Content>

Accepts one of the following:

String

List<BetaTextBlockParam>

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<List<BetaTextCitationParam>>

Accepts one of the following:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

isError: Optional<Boolean>

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.

fileId: String

type: JsonValue;

Accepts one of the following:

CONTAINER_UPLOAD("container_upload")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<List<BetaTextCitationParam>>

Accepts one of the following:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

source: Source

Accepts one of the following:

class BetaBase64ImageSource:

data: String

formatbyte

mediaType: MediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileImageSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

type: JsonValue;

Accepts one of the following:

CONTENT("content")

class BetaContentBlockSourceContent:

class BetaTextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<List<BetaTextCitationParam>>

Accepts one of the following:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

source: Source

Accepts one of the following:

class BetaBase64ImageSource:

data: String

formatbyte

mediaType: MediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileImageSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

edits: Optional<List<Edit>>

List of context management edits to apply

Accepts one of the following:

class BetaClearToolUses20250919Edit:

type: JsonValue;

Accepts one of the following:

CLEAR_TOOL_USES_20250919("clear_tool_uses_20250919")

clearAtLeast: Optional<BetaInputTokensClearAtLeast>

Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed.

type: JsonValue;

Accepts one of the following:

INPUT_TOKENS("input_tokens")

value: Long

minimum0

clearToolInputs: Optional<ClearToolInputs>

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

Accepts one of the following:

Boolean

List<String>

excludeTools: Optional<List<String>>

Tool names whose uses are preserved from clearing

keep: Optional<BetaToolUsesKeep>

Number of tool uses to retain in the conversation

type: JsonValue;

Accepts one of the following:

TOOL_USES("tool_uses")

value: Long

minimum0

trigger: Optional<Trigger>

Condition that triggers the context management strategy

Accepts one of the following:

class BetaInputTokensTrigger:

type: JsonValue;

Accepts one of the following:

INPUT_TOKENS("input_tokens")

value: Long

minimum1

class BetaToolUsesTrigger:

type: JsonValue;

Accepts one of the following:

TOOL_USES("tool_uses")

value: Long

minimum1

class BetaClearThinking20251015Edit:

type: JsonValue;

Accepts one of the following:

CLEAR_THINKING_20251015("clear_thinking_20251015")

keep: Optional<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:

type: JsonValue;

Accepts one of the following:

THINKING_TURNS("thinking_turns")

value: Long

minimum1

class BetaAllThinkingTurns:

type: JsonValue;

Accepts one of the following:

ALL("all")

JsonValue;

Accepts one of the following:

ALL("all")

class BetaContextManagementResponse:

appliedEdits: List<AppliedEdit>

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse:

clearedInputTokens: Long

Number of input tokens cleared by this edit.

minimum0

clearedToolUses: Long

Number of tool uses that were cleared.

minimum0

type: JsonValue;

The type of context management edit applied.

Accepts one of the following:

CLEAR_TOOL_USES_20250919("clear_tool_uses_20250919")

class BetaClearThinking20251015EditResponse:

clearedInputTokens: Long

Number of input tokens cleared by this edit.

minimum0

clearedThinkingTurns: Long

Number of thinking turns that were cleared.

minimum0

type: JsonValue;

The type of context management edit applied.

Accepts one of the following:

CLEAR_THINKING_20251015("clear_thinking_20251015")

class BetaCountTokensContextManagementResponse:

originalInputTokens: Long

The original token count before context management was applied

class BetaDocumentBlock:

citations: Optional<BetaCitationConfig>

Citation configuration for the document

enabled: Boolean

source: Source

Accepts one of the following:

class BetaBase64PdfSource:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

title: Optional<String>

The title of the document

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

class BetaFileDocumentSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

class BetaFileImageSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

class BetaImageBlockParam:

source: Source

Accepts one of the following:

class BetaBase64ImageSource:

data: String

formatbyte

mediaType: MediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileImageSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

partialJson: String

type: JsonValue;

Accepts one of the following:

INPUT_JSON_DELTA("input_json_delta")

class BetaInputTokensClearAtLeast:

type: JsonValue;

Accepts one of the following:

INPUT_TOKENS("input_tokens")

value: Long

minimum0

class BetaInputTokensTrigger:

type: JsonValue;

Accepts one of the following:

INPUT_TOKENS("input_tokens")

value: Long

minimum1

class BetaMcpToolResultBlock:

content: Content

Accepts one of the following:

String

List<BetaTextBlock>

citations: Optional<List<BetaTextCitation>>

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

text: String

maxLength5000000

minLength0

type: JsonValue;

Accepts one of the following:

TEXT("text")

isError: Boolean

toolUseId: String

type: JsonValue;

Accepts one of the following:

MCP_TOOL_RESULT("mcp_tool_result")

class BetaMcpToolUseBlock:

id: String

input: Input

The name of the MCP tool

serverName: String

The name of the MCP server

type: JsonValue;

Accepts one of the following:

MCP_TOOL_USE("mcp_tool_use")

class BetaMcpToolUseBlockParam:

id: String

input: Input

serverName: String

The name of the MCP server

type: JsonValue;

Accepts one of the following:

MCP_TOOL_USE("mcp_tool_use")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

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

type: JsonValue;

Accepts one of the following:

MEMORY_20250818("memory_20250818")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

command: JsonValue;

Command type identifier

Accepts one of the following:

VIEW("view")

path: String

Path to directory or file to view

viewRange: Optional<List<Long>>

Optional line range for viewing specific lines

class BetaMemoryTool20250818CreateCommand:

command: JsonValue;

Command type identifier

Accepts one of the following:

CREATE("create")

fileText: String

Content to write to the file

path: String

Path where the file should be created

class BetaMemoryTool20250818StrReplaceCommand:

command: JsonValue;

Command type identifier

Accepts one of the following:

STR_REPLACE("str_replace")

newStr: String

Text to replace with

oldStr: String

Text to search for and replace

path: String

Path to the file where text should be replaced

class BetaMemoryTool20250818InsertCommand:

command: JsonValue;

Command type identifier

Accepts one of the following:

INSERT("insert")

insertLine: Long

Line number where text should be inserted

minimum1

insertText: String

Text to insert at the specified line

path: String

Path to the file where text should be inserted

class BetaMemoryTool20250818DeleteCommand:

command: JsonValue;

Command type identifier

Accepts one of the following:

DELETE("delete")

path: String

Path to the file or directory to delete

class BetaMemoryTool20250818RenameCommand:

command: JsonValue;

Command type identifier

Accepts one of the following:

RENAME("rename")

newPath: String

New path for the file or directory

oldPath: String

Current path of the file or directory

class BetaMemoryTool20250818CreateCommand:

command: JsonValue;

Command type identifier

Accepts one of the following:

CREATE("create")

fileText: String

Content to write to the file

path: String

Path where the file should be created

class BetaMemoryTool20250818DeleteCommand:

command: JsonValue;

Command type identifier

Accepts one of the following:

DELETE("delete")

path: String

Path to the file or directory to delete

class BetaMemoryTool20250818InsertCommand:

command: JsonValue;

Command type identifier

Accepts one of the following:

INSERT("insert")

insertLine: Long

Line number where text should be inserted

minimum1

insertText: String

Text to insert at the specified line

path: String

Path to the file where text should be inserted

class BetaMemoryTool20250818RenameCommand:

command: JsonValue;

Command type identifier

Accepts one of the following:

RENAME("rename")

newPath: String

New path for the file or directory

oldPath: String

Current path of the file or directory

class BetaMemoryTool20250818StrReplaceCommand:

command: JsonValue;

Command type identifier

Accepts one of the following:

STR_REPLACE("str_replace")

newStr: String

Text to replace with

oldStr: String

Text to search for and replace

path: String

Path to the file where text should be replaced

class BetaMemoryTool20250818ViewCommand:

command: JsonValue;

Command type identifier

Accepts one of the following:

VIEW("view")

path: String

Path to directory or file to view

viewRange: Optional<List<Long>>

Optional line range for viewing specific lines

class BetaMessage:

id: String

Unique object identifier.

The format and length of IDs may change over time.

container: Optional<BetaContainer>

Information about the container used in the request (for the code execution tool)

id: String

Identifier for the container used in this request

expiresAt: LocalDateTime

The time at which the container will expire.

formatdate-time

skills: Optional<List<BetaSkill>>

Skills loaded in the container

skillId: String

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

version: String

Skill version or 'latest' for most recent version

maxLength64

minLength1

content: List<BetaContentBlock>

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:

citations: Optional<List<BetaTextCitation>>

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

text: String

maxLength5000000

minLength0

type: JsonValue;

Accepts one of the following:

TEXT("text")

class BetaThinkingBlock:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class BetaRedactedThinkingBlock:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaToolUseBlock:

id: String

input: Input

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

class BetaServerToolUseBlock:

id: String

input: Input

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

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

encryptedContent: String

pageAge: Optional<String>

title: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

url: String

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

class BetaWebFetchBlock:

content: BetaDocumentBlock

citations: Optional<BetaCitationConfig>

Citation configuration for the document

enabled: Boolean

source: Source

Accepts one of the following:

class BetaBase64PdfSource:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

title: Optional<String>

The title of the document

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

retrievedAt: Optional<String>

ISO 8601 timestamp when the content was retrieved

type: JsonValue;

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

url: String

Fetched content URL

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlock:

content: List<BetaCodeExecutionOutputBlock>

fileId: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")

class BetaBashCodeExecutionResultBlock:

content: List<BetaBashCodeExecutionOutputBlock>

fileId: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")

toolUseId: String

type: JsonValue;

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

errorMessage: Optional<String>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

class BetaTextEditorCodeExecutionViewResultBlock:

content: String

fileType: FileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

numLines: Optional<Long>

startLine: Optional<Long>

totalLines: Optional<Long>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

class BetaTextEditorCodeExecutionCreateResultBlock:

isFileUpdate: Boolean

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlock:

lines: Optional<List<String>>

newLines: Optional<Long>

newStart: Optional<Long>

oldLines: Optional<Long>

oldStart: Optional<Long>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

toolUseId: String

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")

class BetaMcpToolUseBlock:

id: String

input: Input

The name of the MCP tool

serverName: String

The name of the MCP server

type: JsonValue;

Accepts one of the following:

MCP_TOOL_USE("mcp_tool_use")

class BetaMcpToolResultBlock:

content: Content

Accepts one of the following:

String

List<BetaTextBlock>

citations: Optional<List<BetaTextCitation>>

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

text: String

maxLength5000000

minLength0

type: JsonValue;

Accepts one of the following:

TEXT("text")

isError: Boolean

toolUseId: String

type: JsonValue;

Accepts one of the following:

MCP_TOOL_RESULT("mcp_tool_result")

class BetaContainerUploadBlock:

Response model for a file uploaded to the container.

fileId: String

type: JsonValue;

Accepts one of the following:

CONTAINER_UPLOAD("container_upload")

contextManagement: Optional<BetaContextManagementResponse>

Context management response.

Information about context management strategies applied during the request.

appliedEdits: List<AppliedEdit>

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse:

clearedInputTokens: Long

Number of input tokens cleared by this edit.

minimum0

clearedToolUses: Long

Number of tool uses that were cleared.

minimum0

type: JsonValue;

The type of context management edit applied.

Accepts one of the following:

CLEAR_TOOL_USES_20250919("clear_tool_uses_20250919")

class BetaClearThinking20251015EditResponse:

clearedInputTokens: Long

Number of input tokens cleared by this edit.

minimum0

clearedThinkingTurns: Long

Number of thinking turns that were cleared.

minimum0

type: JsonValue;

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

role: JsonValue;

Conversational role of the generated message.

This will always be "assistant".

Accepts one of the following:

ASSISTANT("assistant")

stopReason: Optional<BetaStopReason>

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

stopSequence: Optional<String>

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.

type: JsonValue;

Object type.

For Messages, this is always "message".

Accepts one of the following:

MESSAGE("message")

usage: BetaUsage

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.

cacheCreation: Optional<BetaCacheCreation>

Breakdown of cached tokens by TTL

ephemeral1hInputTokens: Long

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

minimum0

ephemeral5mInputTokens: Long

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

minimum0

cacheCreationInputTokens: Optional<Long>

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

minimum0

cacheReadInputTokens: Optional<Long>

The number of input tokens read from the cache.

minimum0

inputTokens: Long

The number of input tokens which were used.

minimum0

outputTokens: Long

The number of output tokens which were used.

minimum0

serverToolUse: Optional<BetaServerToolUsage>

The number of server tool requests.

webFetchRequests: Long

The number of web fetch tool requests.

minimum0

webSearchRequests: Long

The number of web search tool requests.

minimum0

serviceTier: Optional<ServiceTier>

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

Accepts one of the following:

STANDARD("standard")

PRIORITY("priority")

BATCH("batch")

class BetaMessageDeltaUsage:

cacheCreationInputTokens: Optional<Long>

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

minimum0

cacheReadInputTokens: Optional<Long>

The cumulative number of input tokens read from the cache.

minimum0

inputTokens: Optional<Long>

The cumulative number of input tokens which were used.

minimum0

outputTokens: Long

The cumulative number of output tokens which were used.

serverToolUse: Optional<BetaServerToolUsage>

The number of server tool requests.

webFetchRequests: Long

The number of web fetch tool requests.

minimum0

webSearchRequests: Long

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:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<List<BetaTextCitationParam>>

Accepts one of the following:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

source: Source

Accepts one of the following:

class BetaBase64ImageSource:

data: String

formatbyte

mediaType: MediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileImageSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

class BetaContentBlockSource:

content: Content

Accepts one of the following:

String

Accepts one of the following:

class BetaTextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<List<BetaTextCitationParam>>

Accepts one of the following:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

source: Source

Accepts one of the following:

class BetaBase64ImageSource:

data: String

formatbyte

mediaType: MediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileImageSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

type: JsonValue;

Accepts one of the following:

CONTENT("content")

class BetaUrlPdfSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileDocumentSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<BetaCitationsConfigParam>

enabled: Optional<Boolean>

context: Optional<String>

minLength1

title: Optional<String>

maxLength500

minLength1

class BetaSearchResultBlockParam:

content: List<BetaTextBlockParam>

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<List<BetaTextCitationParam>>

Accepts one of the following:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

source: String

title: String

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT("search_result")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<BetaCitationsConfigParam>

enabled: Optional<Boolean>

class BetaThinkingBlockParam:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class BetaRedactedThinkingBlockParam:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaToolUseBlockParam:

id: String

input: Input

maxLength200

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

toolUseId: String

type: JsonValue;

Accepts one of the following:

TOOL_RESULT("tool_result")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

content: Optional<Content>

Accepts one of the following:

String

List<Block>

Accepts one of the following:

class BetaTextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<List<BetaTextCitationParam>>

Accepts one of the following:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

source: Source

Accepts one of the following:

class BetaBase64ImageSource:

data: String

formatbyte

mediaType: MediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileImageSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

content: List<BetaTextBlockParam>

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<List<BetaTextCitationParam>>

Accepts one of the following:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

source: String

title: String

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT("search_result")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<BetaCitationsConfigParam>

enabled: Optional<Boolean>

class BetaRequestDocumentBlock:

source: Source

Accepts one of the following:

class BetaBase64PdfSource:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

class BetaContentBlockSource:

content: Content

Accepts one of the following:

String

Accepts one of the following:

class BetaTextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<List<BetaTextCitationParam>>

Accepts one of the following:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

source: Source

Accepts one of the following:

class BetaBase64ImageSource:

data: String

formatbyte

mediaType: MediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileImageSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

type: JsonValue;

Accepts one of the following:

CONTENT("content")

class BetaUrlPdfSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileDocumentSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<BetaCitationsConfigParam>

enabled: Optional<Boolean>

context: Optional<String>

minLength1

title: Optional<String>

maxLength500

minLength1

isError: Optional<Boolean>

class BetaServerToolUseBlockParam:

id: String

input: Input

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

type: JsonValue;

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

content: BetaWebSearchToolResultBlockParamContent

Accepts one of the following:

encryptedContent: String

title: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

url: String

pageAge: Optional<String>

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

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

toolUseId: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT("web_search_tool_result")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

type: JsonValue;

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:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

class BetaContentBlockSource:

content: Content

Accepts one of the following:

String

Accepts one of the following:

class BetaTextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<List<BetaTextCitationParam>>

Accepts one of the following:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

source: Source

Accepts one of the following:

class BetaBase64ImageSource:

data: String

formatbyte

mediaType: MediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileImageSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

type: JsonValue;

Accepts one of the following:

CONTENT("content")

class BetaUrlPdfSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileDocumentSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<BetaCitationsConfigParam>

enabled: Optional<Boolean>

context: Optional<String>

minLength1

title: Optional<String>

maxLength500

minLength1

type: JsonValue;

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

url: String

Fetched content URL

retrievedAt: Optional<String>

ISO 8601 timestamp when the content was retrieved

toolUseId: String

type: JsonValue;

Accepts one of the following:

WEB_FETCH_TOOL_RESULT("web_fetch_tool_result")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

content: BetaCodeExecutionToolResultBlockParamContent

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

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlockParam:

content: List<BetaCodeExecutionOutputBlockParam>

fileId: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

toolUseId: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT("code_execution_tool_result")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")

class BetaBashCodeExecutionResultBlockParam:

content: List<BetaBashCodeExecutionOutputBlockParam>

fileId: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")

toolUseId: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT("bash_code_execution_tool_result")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

errorMessage: Optional<String>

class BetaTextEditorCodeExecutionViewResultBlockParam:

content: String

fileType: FileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

numLines: Optional<Long>

startLine: Optional<Long>

totalLines: Optional<Long>

class BetaTextEditorCodeExecutionCreateResultBlockParam:

isFileUpdate: Boolean

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlockParam:

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

lines: Optional<List<String>>

newLines: Optional<Long>

newStart: Optional<Long>

oldLines: Optional<Long>

oldStart: Optional<Long>

toolUseId: String

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

id: String

input: Input

serverName: String

The name of the MCP server

type: JsonValue;

Accepts one of the following:

MCP_TOOL_USE("mcp_tool_use")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

toolUseId: String

type: JsonValue;

Accepts one of the following:

MCP_TOOL_RESULT("mcp_tool_result")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

content: Optional<Content>

Accepts one of the following:

String

List<BetaTextBlockParam>

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<List<BetaTextCitationParam>>

Accepts one of the following:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

isError: Optional<Boolean>

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.

fileId: String

type: JsonValue;

Accepts one of the following:

CONTAINER_UPLOAD("container_upload")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

contextManagement: Optional<BetaCountTokensContextManagementResponse>

Information about context management applied to the message.

originalInputTokens: Long

The original token count before context management was applied

inputTokens: Long

The total number of tokens across the provided list of messages, system prompt, and tools.

class BetaMetadata:

userId: Optional<String>

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:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

class BetaRawContentBlockDelta:

class BetaTextDelta:

text: String

type: JsonValue;

Accepts one of the following:

TEXT_DELTA("text_delta")

class BetaInputJsonDelta:

partialJson: String

type: JsonValue;

Accepts one of the following:

INPUT_JSON_DELTA("input_json_delta")

class BetaCitationsDelta:

citation: Citation

Accepts one of the following:

class BetaCitationCharLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

type: JsonValue;

Accepts one of the following:

CITATIONS_DELTA("citations_delta")

class BetaThinkingDelta:

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING_DELTA("thinking_delta")

class BetaSignatureDelta:

signature: String

type: JsonValue;

Accepts one of the following:

SIGNATURE_DELTA("signature_delta")

class BetaRawContentBlockDeltaEvent:

delta: BetaRawContentBlockDelta

Accepts one of the following:

class BetaTextDelta:

text: String

type: JsonValue;

Accepts one of the following:

TEXT_DELTA("text_delta")

class BetaInputJsonDelta:

partialJson: String

type: JsonValue;

Accepts one of the following:

INPUT_JSON_DELTA("input_json_delta")

class BetaCitationsDelta:

citation: Citation

Accepts one of the following:

class BetaCitationCharLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

type: JsonValue;

Accepts one of the following:

CITATIONS_DELTA("citations_delta")

class BetaThinkingDelta:

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING_DELTA("thinking_delta")

class BetaSignatureDelta:

signature: String

type: JsonValue;

Accepts one of the following:

SIGNATURE_DELTA("signature_delta")

index: Long

type: JsonValue;

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:

citations: Optional<List<BetaTextCitation>>

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

text: String

maxLength5000000

minLength0

type: JsonValue;

Accepts one of the following:

TEXT("text")

class BetaThinkingBlock:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class BetaRedactedThinkingBlock:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaToolUseBlock:

id: String

input: Input

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

class BetaServerToolUseBlock:

id: String

input: Input

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

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

encryptedContent: String

pageAge: Optional<String>

title: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

url: String

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

class BetaWebFetchBlock:

content: BetaDocumentBlock

citations: Optional<BetaCitationConfig>

Citation configuration for the document

enabled: Boolean

source: Source

Accepts one of the following:

class BetaBase64PdfSource:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

title: Optional<String>

The title of the document

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

retrievedAt: Optional<String>

ISO 8601 timestamp when the content was retrieved

type: JsonValue;

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

url: String

Fetched content URL

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlock:

content: List<BetaCodeExecutionOutputBlock>

fileId: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")

class BetaBashCodeExecutionResultBlock:

content: List<BetaBashCodeExecutionOutputBlock>

fileId: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")

toolUseId: String

type: JsonValue;

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

errorMessage: Optional<String>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

class BetaTextEditorCodeExecutionViewResultBlock:

content: String

fileType: FileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

numLines: Optional<Long>

startLine: Optional<Long>

totalLines: Optional<Long>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

class BetaTextEditorCodeExecutionCreateResultBlock:

isFileUpdate: Boolean

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlock:

lines: Optional<List<String>>

newLines: Optional<Long>

newStart: Optional<Long>

oldLines: Optional<Long>

oldStart: Optional<Long>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

toolUseId: String

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")

class BetaMcpToolUseBlock:

id: String

input: Input

The name of the MCP tool

serverName: String

The name of the MCP server

type: JsonValue;

Accepts one of the following:

MCP_TOOL_USE("mcp_tool_use")

class BetaMcpToolResultBlock:

content: Content

Accepts one of the following:

String

List<BetaTextBlock>

citations: Optional<List<BetaTextCitation>>

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

text: String

maxLength5000000

minLength0

type: JsonValue;

Accepts one of the following:

TEXT("text")

isError: Boolean

toolUseId: String

type: JsonValue;

Accepts one of the following:

MCP_TOOL_RESULT("mcp_tool_result")

class BetaContainerUploadBlock:

Response model for a file uploaded to the container.

fileId: String

type: JsonValue;

Accepts one of the following:

CONTAINER_UPLOAD("container_upload")

index: Long

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_START("content_block_start")

class BetaRawContentBlockStopEvent:

index: Long

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_STOP("content_block_stop")

class BetaRawMessageDeltaEvent:

contextManagement: Optional<BetaContextManagementResponse>

Information about context management strategies applied during the request

appliedEdits: List<AppliedEdit>

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse:

clearedInputTokens: Long

Number of input tokens cleared by this edit.

minimum0

clearedToolUses: Long

Number of tool uses that were cleared.

minimum0

type: JsonValue;

The type of context management edit applied.

Accepts one of the following:

CLEAR_TOOL_USES_20250919("clear_tool_uses_20250919")

class BetaClearThinking20251015EditResponse:

clearedInputTokens: Long

Number of input tokens cleared by this edit.

minimum0

clearedThinkingTurns: Long

Number of thinking turns that were cleared.

minimum0

type: JsonValue;

The type of context management edit applied.

Accepts one of the following:

CLEAR_THINKING_20251015("clear_thinking_20251015")

delta: Delta

container: Optional<BetaContainer>

Information about the container used in the request (for the code execution tool)

id: String

Identifier for the container used in this request

expiresAt: LocalDateTime

The time at which the container will expire.

formatdate-time

skills: Optional<List<BetaSkill>>

Skills loaded in the container

skillId: String

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

version: String

Skill version or 'latest' for most recent version

maxLength64

minLength1

stopReason: Optional<BetaStopReason>

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

stopSequence: Optional<String>

type: JsonValue;

Accepts one of the following:

MESSAGE_DELTA("message_delta")

usage: BetaMessageDeltaUsage

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.

cacheCreationInputTokens: Optional<Long>

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

minimum0

cacheReadInputTokens: Optional<Long>

The cumulative number of input tokens read from the cache.

minimum0

inputTokens: Optional<Long>

The cumulative number of input tokens which were used.

minimum0

outputTokens: Long

The cumulative number of output tokens which were used.

serverToolUse: Optional<BetaServerToolUsage>

The number of server tool requests.

webFetchRequests: Long

The number of web fetch tool requests.

minimum0

webSearchRequests: Long

The number of web search tool requests.

minimum0

class BetaRawMessageStartEvent:

message: BetaMessage

id: String

Unique object identifier.

The format and length of IDs may change over time.

container: Optional<BetaContainer>

Information about the container used in the request (for the code execution tool)

id: String

Identifier for the container used in this request

expiresAt: LocalDateTime

The time at which the container will expire.

formatdate-time

skills: Optional<List<BetaSkill>>

Skills loaded in the container

skillId: String

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

version: String

Skill version or 'latest' for most recent version

maxLength64

minLength1

content: List<BetaContentBlock>

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:

citations: Optional<List<BetaTextCitation>>

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

text: String

maxLength5000000

minLength0

type: JsonValue;

Accepts one of the following:

TEXT("text")

class BetaThinkingBlock:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class BetaRedactedThinkingBlock:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaToolUseBlock:

id: String

input: Input

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

class BetaServerToolUseBlock:

id: String

input: Input

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

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

encryptedContent: String

pageAge: Optional<String>

title: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

url: String

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

class BetaWebFetchBlock:

content: BetaDocumentBlock

citations: Optional<BetaCitationConfig>

Citation configuration for the document

enabled: Boolean

source: Source

Accepts one of the following:

class BetaBase64PdfSource:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

title: Optional<String>

The title of the document

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

retrievedAt: Optional<String>

ISO 8601 timestamp when the content was retrieved

type: JsonValue;

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

url: String

Fetched content URL

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlock:

content: List<BetaCodeExecutionOutputBlock>

fileId: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")

class BetaBashCodeExecutionResultBlock:

content: List<BetaBashCodeExecutionOutputBlock>

fileId: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")

toolUseId: String

type: JsonValue;

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

errorMessage: Optional<String>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

class BetaTextEditorCodeExecutionViewResultBlock:

content: String

fileType: FileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

numLines: Optional<Long>

startLine: Optional<Long>

totalLines: Optional<Long>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

class BetaTextEditorCodeExecutionCreateResultBlock:

isFileUpdate: Boolean

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlock:

lines: Optional<List<String>>

newLines: Optional<Long>

newStart: Optional<Long>

oldLines: Optional<Long>

oldStart: Optional<Long>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

toolUseId: String

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")

class BetaMcpToolUseBlock:

id: String

input: Input

The name of the MCP tool

serverName: String

The name of the MCP server

type: JsonValue;

Accepts one of the following:

MCP_TOOL_USE("mcp_tool_use")

class BetaMcpToolResultBlock:

content: Content

Accepts one of the following:

String

List<BetaTextBlock>

citations: Optional<List<BetaTextCitation>>

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

text: String

maxLength5000000

minLength0

type: JsonValue;

Accepts one of the following:

TEXT("text")

isError: Boolean

toolUseId: String

type: JsonValue;

Accepts one of the following:

MCP_TOOL_RESULT("mcp_tool_result")

class BetaContainerUploadBlock:

Response model for a file uploaded to the container.

fileId: String

type: JsonValue;

Accepts one of the following:

CONTAINER_UPLOAD("container_upload")

contextManagement: Optional<BetaContextManagementResponse>

Context management response.

Information about context management strategies applied during the request.

appliedEdits: List<AppliedEdit>

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse:

clearedInputTokens: Long

Number of input tokens cleared by this edit.

minimum0

clearedToolUses: Long

Number of tool uses that were cleared.

minimum0

type: JsonValue;

The type of context management edit applied.

Accepts one of the following:

CLEAR_TOOL_USES_20250919("clear_tool_uses_20250919")

class BetaClearThinking20251015EditResponse:

clearedInputTokens: Long

Number of input tokens cleared by this edit.

minimum0

clearedThinkingTurns: Long

Number of thinking turns that were cleared.

minimum0

type: JsonValue;

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

role: JsonValue;

Conversational role of the generated message.

This will always be "assistant".

Accepts one of the following:

ASSISTANT("assistant")

stopReason: Optional<BetaStopReason>

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

stopSequence: Optional<String>

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.

type: JsonValue;

Object type.

For Messages, this is always "message".

Accepts one of the following:

MESSAGE("message")

usage: BetaUsage

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.

cacheCreation: Optional<BetaCacheCreation>

Breakdown of cached tokens by TTL

ephemeral1hInputTokens: Long

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

minimum0

ephemeral5mInputTokens: Long

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

minimum0

cacheCreationInputTokens: Optional<Long>

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

minimum0

cacheReadInputTokens: Optional<Long>

The number of input tokens read from the cache.

minimum0

inputTokens: Long

The number of input tokens which were used.

minimum0

outputTokens: Long

The number of output tokens which were used.

minimum0

serverToolUse: Optional<BetaServerToolUsage>

The number of server tool requests.

webFetchRequests: Long

The number of web fetch tool requests.

minimum0

webSearchRequests: Long

The number of web search tool requests.

minimum0

serviceTier: Optional<ServiceTier>

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

Accepts one of the following:

STANDARD("standard")

PRIORITY("priority")

BATCH("batch")

type: JsonValue;

Accepts one of the following:

MESSAGE_START("message_start")

class BetaRawMessageStopEvent:

type: JsonValue;

Accepts one of the following:

MESSAGE_STOP("message_stop")

class BetaRawMessageStreamEvent:

class BetaRawMessageStartEvent:

message: BetaMessage

id: String

Unique object identifier.

The format and length of IDs may change over time.

container: Optional<BetaContainer>

Information about the container used in the request (for the code execution tool)

id: String

Identifier for the container used in this request

expiresAt: LocalDateTime

The time at which the container will expire.

formatdate-time

skills: Optional<List<BetaSkill>>

Skills loaded in the container

skillId: String

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

version: String

Skill version or 'latest' for most recent version

maxLength64

minLength1

content: List<BetaContentBlock>

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:

citations: Optional<List<BetaTextCitation>>

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

text: String

maxLength5000000

minLength0

type: JsonValue;

Accepts one of the following:

TEXT("text")

class BetaThinkingBlock:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class BetaRedactedThinkingBlock:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaToolUseBlock:

id: String

input: Input

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

class BetaServerToolUseBlock:

id: String

input: Input

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

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

encryptedContent: String

pageAge: Optional<String>

title: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

url: String

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

class BetaWebFetchBlock:

content: BetaDocumentBlock

citations: Optional<BetaCitationConfig>

Citation configuration for the document

enabled: Boolean

source: Source

Accepts one of the following:

class BetaBase64PdfSource:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

title: Optional<String>

The title of the document

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

retrievedAt: Optional<String>

ISO 8601 timestamp when the content was retrieved

type: JsonValue;

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

url: String

Fetched content URL

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlock:

content: List<BetaCodeExecutionOutputBlock>

fileId: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")

class BetaBashCodeExecutionResultBlock:

content: List<BetaBashCodeExecutionOutputBlock>

fileId: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")

toolUseId: String

type: JsonValue;

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

errorMessage: Optional<String>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

class BetaTextEditorCodeExecutionViewResultBlock:

content: String

fileType: FileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

numLines: Optional<Long>

startLine: Optional<Long>

totalLines: Optional<Long>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

class BetaTextEditorCodeExecutionCreateResultBlock:

isFileUpdate: Boolean

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlock:

lines: Optional<List<String>>

newLines: Optional<Long>

newStart: Optional<Long>

oldLines: Optional<Long>

oldStart: Optional<Long>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

toolUseId: String

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")

class BetaMcpToolUseBlock:

id: String

input: Input

The name of the MCP tool

serverName: String

The name of the MCP server

type: JsonValue;

Accepts one of the following:

MCP_TOOL_USE("mcp_tool_use")

class BetaMcpToolResultBlock:

content: Content

Accepts one of the following:

String

List<BetaTextBlock>

citations: Optional<List<BetaTextCitation>>

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

text: String

maxLength5000000

minLength0

type: JsonValue;

Accepts one of the following:

TEXT("text")

isError: Boolean

toolUseId: String

type: JsonValue;

Accepts one of the following:

MCP_TOOL_RESULT("mcp_tool_result")

class BetaContainerUploadBlock:

Response model for a file uploaded to the container.

fileId: String

type: JsonValue;

Accepts one of the following:

CONTAINER_UPLOAD("container_upload")

contextManagement: Optional<BetaContextManagementResponse>

Context management response.

Information about context management strategies applied during the request.

appliedEdits: List<AppliedEdit>

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse:

clearedInputTokens: Long

Number of input tokens cleared by this edit.

minimum0

clearedToolUses: Long

Number of tool uses that were cleared.

minimum0

type: JsonValue;

The type of context management edit applied.

Accepts one of the following:

CLEAR_TOOL_USES_20250919("clear_tool_uses_20250919")

class BetaClearThinking20251015EditResponse:

clearedInputTokens: Long

Number of input tokens cleared by this edit.

minimum0

clearedThinkingTurns: Long

Number of thinking turns that were cleared.

minimum0

type: JsonValue;

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

role: JsonValue;

Conversational role of the generated message.

This will always be "assistant".

Accepts one of the following:

ASSISTANT("assistant")

stopReason: Optional<BetaStopReason>

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

stopSequence: Optional<String>

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.

type: JsonValue;

Object type.

For Messages, this is always "message".

Accepts one of the following:

MESSAGE("message")

usage: BetaUsage

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.

cacheCreation: Optional<BetaCacheCreation>

Breakdown of cached tokens by TTL

ephemeral1hInputTokens: Long

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

minimum0

ephemeral5mInputTokens: Long

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

minimum0

cacheCreationInputTokens: Optional<Long>

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

minimum0

cacheReadInputTokens: Optional<Long>

The number of input tokens read from the cache.

minimum0

inputTokens: Long

The number of input tokens which were used.

minimum0

outputTokens: Long

The number of output tokens which were used.

minimum0

serverToolUse: Optional<BetaServerToolUsage>

The number of server tool requests.

webFetchRequests: Long

The number of web fetch tool requests.

minimum0

webSearchRequests: Long

The number of web search tool requests.

minimum0

serviceTier: Optional<ServiceTier>

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

Accepts one of the following:

STANDARD("standard")

PRIORITY("priority")

BATCH("batch")

type: JsonValue;

Accepts one of the following:

MESSAGE_START("message_start")

class BetaRawMessageDeltaEvent:

contextManagement: Optional<BetaContextManagementResponse>

Information about context management strategies applied during the request

appliedEdits: List<AppliedEdit>

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse:

clearedInputTokens: Long

Number of input tokens cleared by this edit.

minimum0

clearedToolUses: Long

Number of tool uses that were cleared.

minimum0

type: JsonValue;

The type of context management edit applied.

Accepts one of the following:

CLEAR_TOOL_USES_20250919("clear_tool_uses_20250919")

class BetaClearThinking20251015EditResponse:

clearedInputTokens: Long

Number of input tokens cleared by this edit.

minimum0

clearedThinkingTurns: Long

Number of thinking turns that were cleared.

minimum0

type: JsonValue;

The type of context management edit applied.

Accepts one of the following:

CLEAR_THINKING_20251015("clear_thinking_20251015")

delta: Delta

container: Optional<BetaContainer>

Information about the container used in the request (for the code execution tool)

id: String

Identifier for the container used in this request

expiresAt: LocalDateTime

The time at which the container will expire.

formatdate-time

skills: Optional<List<BetaSkill>>

Skills loaded in the container

skillId: String

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

version: String

Skill version or 'latest' for most recent version

maxLength64

minLength1

stopReason: Optional<BetaStopReason>

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

stopSequence: Optional<String>

type: JsonValue;

Accepts one of the following:

MESSAGE_DELTA("message_delta")

usage: BetaMessageDeltaUsage

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.

cacheCreationInputTokens: Optional<Long>

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

minimum0

cacheReadInputTokens: Optional<Long>

The cumulative number of input tokens read from the cache.

minimum0

inputTokens: Optional<Long>

The cumulative number of input tokens which were used.

minimum0

outputTokens: Long

The cumulative number of output tokens which were used.

serverToolUse: Optional<BetaServerToolUsage>

The number of server tool requests.

webFetchRequests: Long

The number of web fetch tool requests.

minimum0

webSearchRequests: Long

The number of web search tool requests.

minimum0

class BetaRawMessageStopEvent:

type: JsonValue;

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:

citations: Optional<List<BetaTextCitation>>

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

text: String

maxLength5000000

minLength0

type: JsonValue;

Accepts one of the following:

TEXT("text")

class BetaThinkingBlock:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class BetaRedactedThinkingBlock:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaToolUseBlock:

id: String

input: Input

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

class BetaServerToolUseBlock:

id: String

input: Input

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

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

encryptedContent: String

pageAge: Optional<String>

title: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

url: String

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

class BetaWebFetchBlock:

content: BetaDocumentBlock

citations: Optional<BetaCitationConfig>

Citation configuration for the document

enabled: Boolean

source: Source

Accepts one of the following:

class BetaBase64PdfSource:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

title: Optional<String>

The title of the document

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

retrievedAt: Optional<String>

ISO 8601 timestamp when the content was retrieved

type: JsonValue;

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

url: String

Fetched content URL

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlock:

content: List<BetaCodeExecutionOutputBlock>

fileId: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")

class BetaBashCodeExecutionResultBlock:

content: List<BetaBashCodeExecutionOutputBlock>

fileId: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")

toolUseId: String

type: JsonValue;

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

errorMessage: Optional<String>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

class BetaTextEditorCodeExecutionViewResultBlock:

content: String

fileType: FileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

numLines: Optional<Long>

startLine: Optional<Long>

totalLines: Optional<Long>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

class BetaTextEditorCodeExecutionCreateResultBlock:

isFileUpdate: Boolean

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlock:

lines: Optional<List<String>>

newLines: Optional<Long>

newStart: Optional<Long>

oldLines: Optional<Long>

oldStart: Optional<Long>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

toolUseId: String

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")

class BetaMcpToolUseBlock:

id: String

input: Input

The name of the MCP tool

serverName: String

The name of the MCP server

type: JsonValue;

Accepts one of the following:

MCP_TOOL_USE("mcp_tool_use")

class BetaMcpToolResultBlock:

content: Content

Accepts one of the following:

String

List<BetaTextBlock>

citations: Optional<List<BetaTextCitation>>

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

text: String

maxLength5000000

minLength0

type: JsonValue;

Accepts one of the following:

TEXT("text")

isError: Boolean

toolUseId: String

type: JsonValue;

Accepts one of the following:

MCP_TOOL_RESULT("mcp_tool_result")

class BetaContainerUploadBlock:

Response model for a file uploaded to the container.

fileId: String

type: JsonValue;

Accepts one of the following:

CONTAINER_UPLOAD("container_upload")

index: Long

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_START("content_block_start")

class BetaRawContentBlockDeltaEvent:

delta: BetaRawContentBlockDelta

Accepts one of the following:

class BetaTextDelta:

text: String

type: JsonValue;

Accepts one of the following:

TEXT_DELTA("text_delta")

class BetaInputJsonDelta:

partialJson: String

type: JsonValue;

Accepts one of the following:

INPUT_JSON_DELTA("input_json_delta")

class BetaCitationsDelta:

citation: Citation

Accepts one of the following:

class BetaCitationCharLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

type: JsonValue;

Accepts one of the following:

CITATIONS_DELTA("citations_delta")

class BetaThinkingDelta:

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING_DELTA("thinking_delta")

class BetaSignatureDelta:

signature: String

type: JsonValue;

Accepts one of the following:

SIGNATURE_DELTA("signature_delta")

index: Long

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_DELTA("content_block_delta")

class BetaRawContentBlockStopEvent:

index: Long

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_STOP("content_block_stop")

class BetaRedactedThinkingBlock:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaRedactedThinkingBlockParam:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaRequestDocumentBlock:

source: Source

Accepts one of the following:

class BetaBase64PdfSource:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

class BetaContentBlockSource:

content: Content

Accepts one of the following:

String

Accepts one of the following:

class BetaTextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<List<BetaTextCitationParam>>

Accepts one of the following:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

source: Source

Accepts one of the following:

class BetaBase64ImageSource:

data: String

formatbyte

mediaType: MediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileImageSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

type: JsonValue;

Accepts one of the following:

CONTENT("content")

class BetaUrlPdfSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileDocumentSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<BetaCitationsConfigParam>

enabled: Optional<Boolean>

context: Optional<String>

minLength1

title: Optional<String>

maxLength500

minLength1

class BetaRequestMcpServerToolConfiguration:

allowedTools: Optional<List<String>>

enabled: Optional<Boolean>

class BetaRequestMcpServerUrlDefinition:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

authorizationToken: Optional<String>

toolConfiguration: Optional<BetaRequestMcpServerToolConfiguration>

allowedTools: Optional<List<String>>

enabled: Optional<Boolean>

class BetaRequestMcpToolResultBlockParam:

toolUseId: String

type: JsonValue;

Accepts one of the following:

MCP_TOOL_RESULT("mcp_tool_result")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

content: Optional<Content>

Accepts one of the following:

String

List<BetaTextBlockParam>

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<List<BetaTextCitationParam>>

Accepts one of the following:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

isError: Optional<Boolean>

class BetaSearchResultBlockParam:

content: List<BetaTextBlockParam>

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<List<BetaTextCitationParam>>

Accepts one of the following:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

source: String

title: String

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT("search_result")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<BetaCitationsConfigParam>

enabled: Optional<Boolean>

class BetaServerToolUsage:

webFetchRequests: Long

The number of web fetch tool requests.

minimum0

webSearchRequests: Long

The number of web search tool requests.

minimum0

class BetaServerToolUseBlock:

id: String

input: Input

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

type: JsonValue;

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

class BetaServerToolUseBlockParam:

id: String

input: Input

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

type: JsonValue;

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

signature: String

type: JsonValue;

Accepts one of the following:

SIGNATURE_DELTA("signature_delta")

class BetaSkill:

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

skillId: String

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

version: String

Skill version or 'latest' for most recent version

maxLength64

minLength1

class BetaSkillParams:

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

skillId: String

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

version: Optional<String>

Skill version or 'latest' for most recent version

maxLength64

minLength1

enum class 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:

citations: Optional<List<BetaTextCitation>>

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

text: String

maxLength5000000

minLength0

type: JsonValue;

Accepts one of the following:

TEXT("text")

class BetaTextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<List<BetaTextCitationParam>>

Accepts one of the following:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaTextCitation:

class BetaCitationCharLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaTextCitationParam:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaTextDelta:

text: String

type: JsonValue;

Accepts one of the following:

TEXT_DELTA("text_delta")

class BetaTextEditorCodeExecutionCreateResultBlock:

isFileUpdate: Boolean

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionCreateResultBlockParam:

isFileUpdate: Boolean

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlock:

lines: Optional<List<String>>

newLines: Optional<Long>

newStart: Optional<Long>

oldLines: Optional<Long>

oldStart: Optional<Long>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlockParam:

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

lines: Optional<List<String>>

newLines: Optional<Long>

newStart: Optional<Long>

oldLines: Optional<Long>

oldStart: Optional<Long>

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

errorMessage: Optional<String>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

class BetaTextEditorCodeExecutionViewResultBlock:

content: String

fileType: FileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

numLines: Optional<Long>

startLine: Optional<Long>

totalLines: Optional<Long>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

class BetaTextEditorCodeExecutionCreateResultBlock:

isFileUpdate: Boolean

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlock:

lines: Optional<List<String>>

newLines: Optional<Long>

newStart: Optional<Long>

oldLines: Optional<Long>

oldStart: Optional<Long>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

errorMessage: Optional<String>

class BetaTextEditorCodeExecutionViewResultBlockParam:

content: String

fileType: FileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

numLines: Optional<Long>

startLine: Optional<Long>

totalLines: Optional<Long>

class BetaTextEditorCodeExecutionCreateResultBlockParam:

isFileUpdate: Boolean

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlockParam:

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

lines: Optional<List<String>>

newLines: Optional<Long>

newStart: Optional<Long>

oldLines: Optional<Long>

oldStart: Optional<Long>

toolUseId: String

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

errorMessage: Optional<String>

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

errorMessage: Optional<String>

class BetaTextEditorCodeExecutionViewResultBlock:

content: String

fileType: FileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

numLines: Optional<Long>

startLine: Optional<Long>

totalLines: Optional<Long>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

class BetaTextEditorCodeExecutionViewResultBlockParam:

content: String

fileType: FileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

numLines: Optional<Long>

startLine: Optional<Long>

totalLines: Optional<Long>

class BetaThinkingBlock:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class BetaThinkingBlockParam:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class BetaThinkingConfigDisabled:

type: JsonValue;

Accepts one of the following:

DISABLED("disabled")

class BetaThinkingConfigEnabled:

budgetTokens: Long

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

type: JsonValue;

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:

budgetTokens: Long

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

type: JsonValue;

Accepts one of the following:

ENABLED("enabled")

class BetaThinkingConfigDisabled:

type: JsonValue;

Accepts one of the following:

DISABLED("disabled")

class BetaThinkingDelta:

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING_DELTA("thinking_delta")

class BetaThinkingTurns:

type: JsonValue;

Accepts one of the following:

THINKING_TURNS("thinking_turns")

value: Long

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.

type: JsonValue;

Accepts one of the following:

OBJECT("object")

properties: Optional<Properties>

required: Optional<List<String>>

Name of the tool.

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

maxLength128

minLength1

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

description: Optional<String>

Description of what this tool does.

Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema.

type: Optional<Type>

Accepts one of the following:

CUSTOM("custom")

class BetaToolBash20241022:

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

type: JsonValue;

Accepts one of the following:

BASH_20241022("bash_20241022")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

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

type: JsonValue;

Accepts one of the following:

BASH_20250124("bash_20250124")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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.

type: JsonValue;

Accepts one of the following:

AUTO("auto")

disableParallelToolUse: Optional<Boolean>

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.

type: JsonValue;

Accepts one of the following:

ANY("any")

disableParallelToolUse: Optional<Boolean>

Whether to disable parallel tool use.

Defaults to false. If set to true, the model will output exactly one tool use.

class BetaToolChoiceTool:

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

The name of the tool to use.

type: JsonValue;

Accepts one of the following:

TOOL("tool")

disableParallelToolUse: Optional<Boolean>

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.

type: JsonValue;

Accepts one of the following:

NONE("none")

class BetaToolChoiceAny:

The model will use any available tools.

type: JsonValue;

Accepts one of the following:

ANY("any")

disableParallelToolUse: Optional<Boolean>

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.

type: JsonValue;

Accepts one of the following:

AUTO("auto")

disableParallelToolUse: Optional<Boolean>

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.

type: JsonValue;

Accepts one of the following:

NONE("none")

class BetaToolChoiceTool:

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

The name of the tool to use.

type: JsonValue;

Accepts one of the following:

TOOL("tool")

disableParallelToolUse: Optional<Boolean>

Whether to disable parallel tool use.

Defaults to false. If set to true, the model will output exactly one tool use.

class BetaToolComputerUse20241022:

displayHeightPx: Long

The height of the display in pixels.

minimum1

displayWidthPx: Long

The width of the display in pixels.

minimum1

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

type: JsonValue;

Accepts one of the following:

COMPUTER_20241022("computer_20241022")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

displayNumber: Optional<Long>

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

minimum0

class BetaToolComputerUse20250124:

displayHeightPx: Long

The height of the display in pixels.

minimum1

displayWidthPx: Long

The width of the display in pixels.

minimum1

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

type: JsonValue;

Accepts one of the following:

COMPUTER_20250124("computer_20250124")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

displayNumber: Optional<Long>

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

minimum0

class BetaToolResultBlockParam:

toolUseId: String

type: JsonValue;

Accepts one of the following:

TOOL_RESULT("tool_result")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

content: Optional<Content>

Accepts one of the following:

String

List<Block>

Accepts one of the following:

class BetaTextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<List<BetaTextCitationParam>>

Accepts one of the following:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

source: Source

Accepts one of the following:

class BetaBase64ImageSource:

data: String

formatbyte

mediaType: MediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileImageSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

content: List<BetaTextBlockParam>

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<List<BetaTextCitationParam>>

Accepts one of the following:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

source: String

title: String

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT("search_result")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<BetaCitationsConfigParam>

enabled: Optional<Boolean>

class BetaRequestDocumentBlock:

source: Source

Accepts one of the following:

class BetaBase64PdfSource:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

class BetaContentBlockSource:

content: Content

Accepts one of the following:

String

Accepts one of the following:

class BetaTextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<List<BetaTextCitationParam>>

Accepts one of the following:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

source: Source

Accepts one of the following:

class BetaBase64ImageSource:

data: String

formatbyte

mediaType: MediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileImageSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

type: JsonValue;

Accepts one of the following:

CONTENT("content")

class BetaUrlPdfSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileDocumentSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<BetaCitationsConfigParam>

enabled: Optional<Boolean>

context: Optional<String>

minLength1

title: Optional<String>

maxLength500

minLength1

isError: Optional<Boolean>

class BetaToolTextEditor20241022:

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

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_20241022("text_editor_20241022")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

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

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_20250124("text_editor_20250124")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

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

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_20250429("text_editor_20250429")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

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

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_20250728("text_editor_20250728")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

maxCharacters: Optional<Long>

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.

type: JsonValue;

Accepts one of the following:

OBJECT("object")

properties: Optional<Properties>

required: Optional<List<String>>

Name of the tool.

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

maxLength128

minLength1

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

description: Optional<String>

Description of what this tool does.

type: Optional<Type>

Accepts one of the following:

CUSTOM("custom")

class BetaToolBash20241022:

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

type: JsonValue;

Accepts one of the following:

BASH_20241022("bash_20241022")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

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

type: JsonValue;

Accepts one of the following:

BASH_20250124("bash_20250124")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

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

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_20250522("code_execution_20250522")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

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

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_20250825("code_execution_20250825")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

displayHeightPx: Long

The height of the display in pixels.

minimum1

displayWidthPx: Long

The width of the display in pixels.

minimum1

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

type: JsonValue;

Accepts one of the following:

COMPUTER_20241022("computer_20241022")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

displayNumber: Optional<Long>

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

minimum0

class BetaMemoryTool20250818:

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

type: JsonValue;

Accepts one of the following:

MEMORY_20250818("memory_20250818")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

displayHeightPx: Long

The height of the display in pixels.

minimum1

displayWidthPx: Long

The width of the display in pixels.

minimum1

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

type: JsonValue;

Accepts one of the following:

COMPUTER_20250124("computer_20250124")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

displayNumber: Optional<Long>

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

minimum0

class BetaToolTextEditor20241022:

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

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_20241022("text_editor_20241022")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

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

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_20250124("text_editor_20250124")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

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

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_20250429("text_editor_20250429")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

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

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_20250728("text_editor_20250728")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

maxCharacters: Optional<Long>

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

minimum1

class BetaWebSearchTool20250305:

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

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_20250305("web_search_20250305")

allowedDomains: Optional<List<String>>

If provided, only these domains will be included in results. Cannot be used alongside blocked_domains.

blockedDomains: Optional<List<String>>

If provided, these domains will never appear in results. Cannot be used alongside allowed_domains.

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

maxUses: Optional<Long>

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

exclusiveMinimum0

userLocation: Optional<UserLocation>

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

type: JsonValue;

Accepts one of the following:

APPROXIMATE("approximate")

city: Optional<String>

The city of the user.

maxLength255

minLength1

country: Optional<String>

The two letter ISO country code of the user.

maxLength2

minLength2

region: Optional<String>

The region of the user.

maxLength255

minLength1

timezone: Optional<String>

The IANA timezone of the user.

maxLength255

minLength1

class BetaWebFetchTool20250910:

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

type: JsonValue;

Accepts one of the following:

WEB_FETCH_20250910("web_fetch_20250910")

allowedDomains: Optional<List<String>>

List of domains to allow fetching from

blockedDomains: Optional<List<String>>

List of domains to block fetching from

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<BetaCitationsConfigParam>

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

enabled: Optional<Boolean>

maxContentTokens: Optional<Long>

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

maxUses: Optional<Long>

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

exclusiveMinimum0

class BetaToolUseBlock:

id: String

input: Input

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

class BetaToolUseBlockParam:

id: String

input: Input

maxLength200

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

type: JsonValue;

Accepts one of the following:

TOOL_USES("tool_uses")

value: Long

minimum0

class BetaToolUsesTrigger:

type: JsonValue;

Accepts one of the following:

TOOL_USES("tool_uses")

value: Long

minimum1

class BetaUrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaUrlPdfSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaUsage:

cacheCreation: Optional<BetaCacheCreation>

Breakdown of cached tokens by TTL

ephemeral1hInputTokens: Long

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

minimum0

ephemeral5mInputTokens: Long

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

minimum0

cacheCreationInputTokens: Optional<Long>

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

minimum0

cacheReadInputTokens: Optional<Long>

The number of input tokens read from the cache.

minimum0

inputTokens: Long

The number of input tokens which were used.

minimum0

outputTokens: Long

The number of output tokens which were used.

minimum0

serverToolUse: Optional<BetaServerToolUsage>

The number of server tool requests.

webFetchRequests: Long

The number of web fetch tool requests.

minimum0

webSearchRequests: Long

The number of web search tool requests.

minimum0

serviceTier: Optional<ServiceTier>

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

Accepts one of the following:

STANDARD("standard")

PRIORITY("priority")

BATCH("batch")

class BetaWebFetchBlock:

content: BetaDocumentBlock

citations: Optional<BetaCitationConfig>

Citation configuration for the document

enabled: Boolean

source: Source

Accepts one of the following:

class BetaBase64PdfSource:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

title: Optional<String>

The title of the document

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

retrievedAt: Optional<String>

ISO 8601 timestamp when the content was retrieved

type: JsonValue;

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

url: String

Fetched content URL

class BetaWebFetchBlockParam:

source: Source

Accepts one of the following:

class BetaBase64PdfSource:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

class BetaContentBlockSource:

content: Content

Accepts one of the following:

String

Accepts one of the following:

class BetaTextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<List<BetaTextCitationParam>>

Accepts one of the following:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

source: Source

Accepts one of the following:

class BetaBase64ImageSource:

data: String

formatbyte

mediaType: MediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileImageSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

type: JsonValue;

Accepts one of the following:

CONTENT("content")

class BetaUrlPdfSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileDocumentSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<BetaCitationsConfigParam>

enabled: Optional<Boolean>

context: Optional<String>

minLength1

title: Optional<String>

maxLength500

minLength1

type: JsonValue;

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

url: String

Fetched content URL

retrievedAt: Optional<String>

ISO 8601 timestamp when the content was retrieved

class BetaWebFetchTool20250910:

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

type: JsonValue;

Accepts one of the following:

WEB_FETCH_20250910("web_fetch_20250910")

allowedDomains: Optional<List<String>>

List of domains to allow fetching from

blockedDomains: Optional<List<String>>

List of domains to block fetching from

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<BetaCitationsConfigParam>

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

enabled: Optional<Boolean>

maxContentTokens: Optional<Long>

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

maxUses: Optional<Long>

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

type: JsonValue;

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

class BetaWebFetchBlock:

content: BetaDocumentBlock

citations: Optional<BetaCitationConfig>

Citation configuration for the document

enabled: Boolean

source: Source

Accepts one of the following:

class BetaBase64PdfSource:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

title: Optional<String>

The title of the document

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

retrievedAt: Optional<String>

ISO 8601 timestamp when the content was retrieved

type: JsonValue;

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

url: String

Fetched content URL

toolUseId: String

type: JsonValue;

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

type: JsonValue;

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:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

class BetaContentBlockSource:

content: Content

Accepts one of the following:

String

Accepts one of the following:

class BetaTextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<List<BetaTextCitationParam>>

Accepts one of the following:

class BetaCitationCharLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endCharIndex: Long

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endPageNumber: Long

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocationParam:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

maxLength255

minLength1

endBlockIndex: Long

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationWebSearchResultLocationParam:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

minLength1

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

class BetaImageBlockParam:

source: Source

Accepts one of the following:

class BetaBase64ImageSource:

data: String

formatbyte

mediaType: MediaType

Accepts one of the following:

IMAGE_JPEG("image/jpeg")

IMAGE_PNG("image/png")

IMAGE_GIF("image/gif")

IMAGE_WEBP("image/webp")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaUrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileImageSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

type: JsonValue;

Accepts one of the following:

CONTENT("content")

class BetaUrlPdfSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class BetaFileDocumentSource:

fileId: String

type: JsonValue;

Accepts one of the following:

FILE("file")

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

citations: Optional<BetaCitationsConfigParam>

enabled: Optional<Boolean>

context: Optional<String>

minLength1

title: Optional<String>

maxLength500

minLength1

type: JsonValue;

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

url: String

Fetched content URL

retrievedAt: Optional<String>

ISO 8601 timestamp when the content was retrieved

toolUseId: String

type: JsonValue;

Accepts one of the following:

WEB_FETCH_TOOL_RESULT("web_fetch_tool_result")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

enum class 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:

encryptedContent: String

pageAge: Optional<String>

title: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

url: String

class BetaWebSearchResultBlockParam:

encryptedContent: String

title: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

url: String

pageAge: Optional<String>

class BetaWebSearchTool20250305:

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

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_20250305("web_search_20250305")

allowedDomains: Optional<List<String>>

If provided, only these domains will be included in results. Cannot be used alongside blocked_domains.

blockedDomains: Optional<List<String>>

If provided, these domains will never appear in results. Cannot be used alongside allowed_domains.

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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")

maxUses: Optional<Long>

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

exclusiveMinimum0

userLocation: Optional<UserLocation>

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

type: JsonValue;

Accepts one of the following:

APPROXIMATE("approximate")

city: Optional<String>

The city of the user.

maxLength255

minLength1

country: Optional<String>

The two letter ISO country code of the user.

maxLength2

minLength2

region: Optional<String>

The region of the user.

maxLength255

minLength1

timezone: Optional<String>

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

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

encryptedContent: String

pageAge: Optional<String>

title: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

url: String

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

encryptedContent: String

pageAge: Optional<String>

title: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

url: String

class BetaWebSearchToolResultBlockParam:

content: BetaWebSearchToolResultBlockParamContent

Accepts one of the following:

encryptedContent: String

title: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

url: String

pageAge: Optional<String>

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

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

toolUseId: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT("web_search_tool_result")

cacheControl: Optional<BetaCacheControlEphemeral>

Create a cache control breakpoint at this content block.

type: JsonValue;

Accepts one of the following:

EPHEMERAL("ephemeral")

ttl: Optional<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:

encryptedContent: String

title: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

url: String

pageAge: Optional<String>

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

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

enum class 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")

MessagesBatches

Cancel a Message Batch

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

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

Create a Message Batch

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

post/v1/messages/batches?beta=true

Delete a Message Batch

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

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

List Message Batches

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

get/v1/messages/batches?beta=true

Retrieve Message Batch results

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

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

Retrieve a Message Batch

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

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

ModelsExpand Collapse

class BetaDeletedMessageBatch:

id: String

ID of the Message Batch.

type: JsonValue;

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:

id: String

Unique object identifier.

The format and length of IDs may change over time.

archivedAt: Optional<LocalDateTime>

RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.

formatdate-time

cancelInitiatedAt: Optional<LocalDateTime>

RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated.

formatdate-time

createdAt: LocalDateTime

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

formatdate-time

endedAt: Optional<LocalDateTime>

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

expiresAt: LocalDateTime

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

requestCounts: BetaMessageBatchRequestCounts

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.

canceled: Long

Number of requests in the Message Batch that have been canceled.

This is zero until processing of the entire Message Batch has ended.

errored: Long

Number of requests in the Message Batch that encountered an error.

This is zero until processing of the entire Message Batch has ended.

expired: Long

Number of requests in the Message Batch that have expired.

This is zero until processing of the entire Message Batch has ended.

processing: Long

Number of requests in the Message Batch that are processing.

succeeded: Long

Number of requests in the Message Batch that have completed successfully.

This is zero until processing of the entire Message Batch has ended.

resultsUrl: Optional<String>

URL to a .jsonl file containing the results of the Message Batch requests. Specified only once processing ends.

Results in the file are not guaranteed to be in the same order as requests. Use the custom_id field to match results to requests.

type: JsonValue;

Object type.

For Message Batches, this is always "message_batch".

Accepts one of the following:

MESSAGE_BATCH("message_batch")

class BetaMessageBatchCanceledResult:

type: JsonValue;

Accepts one of the following:

CANCELED("canceled")

class BetaMessageBatchErroredResult:

error: BetaErrorResponse

error: BetaError

Accepts one of the following:

class BetaInvalidRequestError:

message: String

type: JsonValue;

Accepts one of the following:

INVALID_REQUEST_ERROR("invalid_request_error")

class BetaAuthenticationError:

message: String

type: JsonValue;

Accepts one of the following:

AUTHENTICATION_ERROR("authentication_error")

class BetaBillingError:

message: String

type: JsonValue;

Accepts one of the following:

BILLING_ERROR("billing_error")

class BetaPermissionError:

message: String

type: JsonValue;

Accepts one of the following:

PERMISSION_ERROR("permission_error")

class BetaNotFoundError:

message: String

type: JsonValue;

Accepts one of the following:

NOT_FOUND_ERROR("not_found_error")

class BetaRateLimitError:

message: String

type: JsonValue;

Accepts one of the following:

RATE_LIMIT_ERROR("rate_limit_error")

class BetaGatewayTimeoutError:

message: String

type: JsonValue;

Accepts one of the following:

TIMEOUT_ERROR("timeout_error")

class BetaApiError:

message: String

type: JsonValue;

Accepts one of the following:

API_ERROR("api_error")

class BetaOverloadedError:

message: String

type: JsonValue;

Accepts one of the following:

OVERLOADED_ERROR("overloaded_error")

requestId: Optional<String>

type: JsonValue;

Accepts one of the following:

ERROR("error")

type: JsonValue;

Accepts one of the following:

ERRORED("errored")

class BetaMessageBatchExpiredResult:

type: JsonValue;

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.

customId: String

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.

result: 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.

Accepts one of the following:

class BetaMessageBatchSucceededResult:

message: BetaMessage

id: String

Unique object identifier.

The format and length of IDs may change over time.

container: Optional<BetaContainer>

Information about the container used in the request (for the code execution tool)

id: String

Identifier for the container used in this request

expiresAt: LocalDateTime

The time at which the container will expire.

formatdate-time

skills: Optional<List<BetaSkill>>

Skills loaded in the container

skillId: String

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

version: String

Skill version or 'latest' for most recent version

maxLength64

minLength1

content: List<BetaContentBlock>

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:

citations: Optional<List<BetaTextCitation>>

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

text: String

maxLength5000000

minLength0

type: JsonValue;

Accepts one of the following:

TEXT("text")

class BetaThinkingBlock:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class BetaRedactedThinkingBlock:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaToolUseBlock:

id: String

input: Input

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

class BetaServerToolUseBlock:

id: String

input: Input

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

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

encryptedContent: String

pageAge: Optional<String>

title: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

url: String

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

class BetaWebFetchBlock:

content: BetaDocumentBlock

citations: Optional<BetaCitationConfig>

Citation configuration for the document

enabled: Boolean

source: Source

Accepts one of the following:

class BetaBase64PdfSource:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

title: Optional<String>

The title of the document

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

retrievedAt: Optional<String>

ISO 8601 timestamp when the content was retrieved

type: JsonValue;

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

url: String

Fetched content URL

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlock:

content: List<BetaCodeExecutionOutputBlock>

fileId: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")

class BetaBashCodeExecutionResultBlock:

content: List<BetaBashCodeExecutionOutputBlock>

fileId: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")

toolUseId: String

type: JsonValue;

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

errorMessage: Optional<String>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

class BetaTextEditorCodeExecutionViewResultBlock:

content: String

fileType: FileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

numLines: Optional<Long>

startLine: Optional<Long>

totalLines: Optional<Long>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

class BetaTextEditorCodeExecutionCreateResultBlock:

isFileUpdate: Boolean

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlock:

lines: Optional<List<String>>

newLines: Optional<Long>

newStart: Optional<Long>

oldLines: Optional<Long>

oldStart: Optional<Long>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

toolUseId: String

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")

class BetaMcpToolUseBlock:

id: String

input: Input

The name of the MCP tool

serverName: String

The name of the MCP server

type: JsonValue;

Accepts one of the following:

MCP_TOOL_USE("mcp_tool_use")

class BetaMcpToolResultBlock:

content: Content

Accepts one of the following:

String

List<BetaTextBlock>

citations: Optional<List<BetaTextCitation>>

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

text: String

maxLength5000000

minLength0

type: JsonValue;

Accepts one of the following:

TEXT("text")

isError: Boolean

toolUseId: String

type: JsonValue;

Accepts one of the following:

MCP_TOOL_RESULT("mcp_tool_result")

class BetaContainerUploadBlock:

Response model for a file uploaded to the container.

fileId: String

type: JsonValue;

Accepts one of the following:

CONTAINER_UPLOAD("container_upload")

contextManagement: Optional<BetaContextManagementResponse>

Context management response.

Information about context management strategies applied during the request.

appliedEdits: List<AppliedEdit>

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse:

clearedInputTokens: Long

Number of input tokens cleared by this edit.

minimum0

clearedToolUses: Long

Number of tool uses that were cleared.

minimum0

type: JsonValue;

The type of context management edit applied.

Accepts one of the following:

CLEAR_TOOL_USES_20250919("clear_tool_uses_20250919")

class BetaClearThinking20251015EditResponse:

clearedInputTokens: Long

Number of input tokens cleared by this edit.

minimum0

clearedThinkingTurns: Long

Number of thinking turns that were cleared.

minimum0

type: JsonValue;

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

role: JsonValue;

Conversational role of the generated message.

This will always be "assistant".

Accepts one of the following:

ASSISTANT("assistant")

stopReason: Optional<BetaStopReason>

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

stopSequence: Optional<String>

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.

type: JsonValue;

Object type.

For Messages, this is always "message".

Accepts one of the following:

MESSAGE("message")

usage: BetaUsage

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.

cacheCreation: Optional<BetaCacheCreation>

Breakdown of cached tokens by TTL

ephemeral1hInputTokens: Long

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

minimum0

ephemeral5mInputTokens: Long

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

minimum0

cacheCreationInputTokens: Optional<Long>

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

minimum0

cacheReadInputTokens: Optional<Long>

The number of input tokens read from the cache.

minimum0

inputTokens: Long

The number of input tokens which were used.

minimum0

outputTokens: Long

The number of output tokens which were used.

minimum0

serverToolUse: Optional<BetaServerToolUsage>

The number of server tool requests.

webFetchRequests: Long

The number of web fetch tool requests.

minimum0

webSearchRequests: Long

The number of web search tool requests.

minimum0

serviceTier: Optional<ServiceTier>

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

Accepts one of the following:

STANDARD("standard")

PRIORITY("priority")

BATCH("batch")

type: JsonValue;

Accepts one of the following:

SUCCEEDED("succeeded")

class BetaMessageBatchErroredResult:

error: BetaErrorResponse

error: BetaError

Accepts one of the following:

class BetaInvalidRequestError:

message: String

type: JsonValue;

Accepts one of the following:

INVALID_REQUEST_ERROR("invalid_request_error")

class BetaAuthenticationError:

message: String

type: JsonValue;

Accepts one of the following:

AUTHENTICATION_ERROR("authentication_error")

class BetaBillingError:

message: String

type: JsonValue;

Accepts one of the following:

BILLING_ERROR("billing_error")

class BetaPermissionError:

message: String

type: JsonValue;

Accepts one of the following:

PERMISSION_ERROR("permission_error")

class BetaNotFoundError:

message: String

type: JsonValue;

Accepts one of the following:

NOT_FOUND_ERROR("not_found_error")

class BetaRateLimitError:

message: String

type: JsonValue;

Accepts one of the following:

RATE_LIMIT_ERROR("rate_limit_error")

class BetaGatewayTimeoutError:

message: String

type: JsonValue;

Accepts one of the following:

TIMEOUT_ERROR("timeout_error")

class BetaApiError:

message: String

type: JsonValue;

Accepts one of the following:

API_ERROR("api_error")

class BetaOverloadedError:

message: String

type: JsonValue;

Accepts one of the following:

OVERLOADED_ERROR("overloaded_error")

requestId: Optional<String>

type: JsonValue;

Accepts one of the following:

ERROR("error")

type: JsonValue;

Accepts one of the following:

ERRORED("errored")

class BetaMessageBatchCanceledResult:

type: JsonValue;

Accepts one of the following:

CANCELED("canceled")

class BetaMessageBatchExpiredResult:

type: JsonValue;

Accepts one of the following:

EXPIRED("expired")

class BetaMessageBatchRequestCounts:

canceled: Long

Number of requests in the Message Batch that have been canceled.

This is zero until processing of the entire Message Batch has ended.

errored: Long

Number of requests in the Message Batch that encountered an error.

This is zero until processing of the entire Message Batch has ended.

expired: Long

Number of requests in the Message Batch that have expired.

This is zero until processing of the entire Message Batch has ended.

processing: Long

Number of requests in the Message Batch that are processing.

succeeded: Long

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:

message: BetaMessage

id: String

Unique object identifier.

The format and length of IDs may change over time.

container: Optional<BetaContainer>

Information about the container used in the request (for the code execution tool)

id: String

Identifier for the container used in this request

expiresAt: LocalDateTime

The time at which the container will expire.

formatdate-time

skills: Optional<List<BetaSkill>>

Skills loaded in the container

skillId: String

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

version: String

Skill version or 'latest' for most recent version

maxLength64

minLength1

content: List<BetaContentBlock>

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:

citations: Optional<List<BetaTextCitation>>

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

text: String

maxLength5000000

minLength0

type: JsonValue;

Accepts one of the following:

TEXT("text")

class BetaThinkingBlock:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class BetaRedactedThinkingBlock:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaToolUseBlock:

id: String

input: Input

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

class BetaServerToolUseBlock:

id: String

input: Input

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

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

encryptedContent: String

pageAge: Optional<String>

title: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

url: String

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

class BetaWebFetchBlock:

content: BetaDocumentBlock

citations: Optional<BetaCitationConfig>

Citation configuration for the document

enabled: Boolean

source: Source

Accepts one of the following:

class BetaBase64PdfSource:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

title: Optional<String>

The title of the document

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

retrievedAt: Optional<String>

ISO 8601 timestamp when the content was retrieved

type: JsonValue;

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

url: String

Fetched content URL

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlock:

content: List<BetaCodeExecutionOutputBlock>

fileId: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")

class BetaBashCodeExecutionResultBlock:

content: List<BetaBashCodeExecutionOutputBlock>

fileId: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")

toolUseId: String

type: JsonValue;

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

errorMessage: Optional<String>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

class BetaTextEditorCodeExecutionViewResultBlock:

content: String

fileType: FileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

numLines: Optional<Long>

startLine: Optional<Long>

totalLines: Optional<Long>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

class BetaTextEditorCodeExecutionCreateResultBlock:

isFileUpdate: Boolean

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlock:

lines: Optional<List<String>>

newLines: Optional<Long>

newStart: Optional<Long>

oldLines: Optional<Long>

oldStart: Optional<Long>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

toolUseId: String

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")

class BetaMcpToolUseBlock:

id: String

input: Input

The name of the MCP tool

serverName: String

The name of the MCP server

type: JsonValue;

Accepts one of the following:

MCP_TOOL_USE("mcp_tool_use")

class BetaMcpToolResultBlock:

content: Content

Accepts one of the following:

String

List<BetaTextBlock>

citations: Optional<List<BetaTextCitation>>

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

text: String

maxLength5000000

minLength0

type: JsonValue;

Accepts one of the following:

TEXT("text")

isError: Boolean

toolUseId: String

type: JsonValue;

Accepts one of the following:

MCP_TOOL_RESULT("mcp_tool_result")

class BetaContainerUploadBlock:

Response model for a file uploaded to the container.

fileId: String

type: JsonValue;

Accepts one of the following:

CONTAINER_UPLOAD("container_upload")

contextManagement: Optional<BetaContextManagementResponse>

Context management response.

Information about context management strategies applied during the request.

appliedEdits: List<AppliedEdit>

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse:

clearedInputTokens: Long

Number of input tokens cleared by this edit.

minimum0

clearedToolUses: Long

Number of tool uses that were cleared.

minimum0

type: JsonValue;

The type of context management edit applied.

Accepts one of the following:

CLEAR_TOOL_USES_20250919("clear_tool_uses_20250919")

class BetaClearThinking20251015EditResponse:

clearedInputTokens: Long

Number of input tokens cleared by this edit.

minimum0

clearedThinkingTurns: Long

Number of thinking turns that were cleared.

minimum0

type: JsonValue;

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

role: JsonValue;

Conversational role of the generated message.

This will always be "assistant".

Accepts one of the following:

ASSISTANT("assistant")

stopReason: Optional<BetaStopReason>

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

stopSequence: Optional<String>

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.

type: JsonValue;

Object type.

For Messages, this is always "message".

Accepts one of the following:

MESSAGE("message")

usage: BetaUsage

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.

cacheCreation: Optional<BetaCacheCreation>

Breakdown of cached tokens by TTL

ephemeral1hInputTokens: Long

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

minimum0

ephemeral5mInputTokens: Long

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

minimum0

cacheCreationInputTokens: Optional<Long>

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

minimum0

cacheReadInputTokens: Optional<Long>

The number of input tokens read from the cache.

minimum0

inputTokens: Long

The number of input tokens which were used.

minimum0

outputTokens: Long

The number of output tokens which were used.

minimum0

serverToolUse: Optional<BetaServerToolUsage>

The number of server tool requests.

webFetchRequests: Long

The number of web fetch tool requests.

minimum0

webSearchRequests: Long

The number of web search tool requests.

minimum0

serviceTier: Optional<ServiceTier>

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

Accepts one of the following:

STANDARD("standard")

PRIORITY("priority")

BATCH("batch")

type: JsonValue;

Accepts one of the following:

SUCCEEDED("succeeded")

class BetaMessageBatchErroredResult:

error: BetaErrorResponse

error: BetaError

Accepts one of the following:

class BetaInvalidRequestError:

message: String

type: JsonValue;

Accepts one of the following:

INVALID_REQUEST_ERROR("invalid_request_error")

class BetaAuthenticationError:

message: String

type: JsonValue;

Accepts one of the following:

AUTHENTICATION_ERROR("authentication_error")

class BetaBillingError:

message: String

type: JsonValue;

Accepts one of the following:

BILLING_ERROR("billing_error")

class BetaPermissionError:

message: String

type: JsonValue;

Accepts one of the following:

PERMISSION_ERROR("permission_error")

class BetaNotFoundError:

message: String

type: JsonValue;

Accepts one of the following:

NOT_FOUND_ERROR("not_found_error")

class BetaRateLimitError:

message: String

type: JsonValue;

Accepts one of the following:

RATE_LIMIT_ERROR("rate_limit_error")

class BetaGatewayTimeoutError:

message: String

type: JsonValue;

Accepts one of the following:

TIMEOUT_ERROR("timeout_error")

class BetaApiError:

message: String

type: JsonValue;

Accepts one of the following:

API_ERROR("api_error")

class BetaOverloadedError:

message: String

type: JsonValue;

Accepts one of the following:

OVERLOADED_ERROR("overloaded_error")

requestId: Optional<String>

type: JsonValue;

Accepts one of the following:

ERROR("error")

type: JsonValue;

Accepts one of the following:

ERRORED("errored")

class BetaMessageBatchCanceledResult:

type: JsonValue;

Accepts one of the following:

CANCELED("canceled")

class BetaMessageBatchExpiredResult:

type: JsonValue;

Accepts one of the following:

EXPIRED("expired")

class BetaMessageBatchSucceededResult:

message: BetaMessage

id: String

Unique object identifier.

The format and length of IDs may change over time.

container: Optional<BetaContainer>

Information about the container used in the request (for the code execution tool)

id: String

Identifier for the container used in this request

expiresAt: LocalDateTime

The time at which the container will expire.

formatdate-time

skills: Optional<List<BetaSkill>>

Skills loaded in the container

skillId: String

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

version: String

Skill version or 'latest' for most recent version

maxLength64

minLength1

content: List<BetaContentBlock>

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:

citations: Optional<List<BetaTextCitation>>

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

text: String

maxLength5000000

minLength0

type: JsonValue;

Accepts one of the following:

TEXT("text")

class BetaThinkingBlock:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class BetaRedactedThinkingBlock:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaToolUseBlock:

id: String

input: Input

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

class BetaServerToolUseBlock:

id: String

input: Input

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

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

encryptedContent: String

pageAge: Optional<String>

title: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

url: String

toolUseId: String

type: JsonValue;

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

type: JsonValue;

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

class BetaWebFetchBlock:

content: BetaDocumentBlock

citations: Optional<BetaCitationConfig>

Citation configuration for the document

enabled: Boolean

source: Source

Accepts one of the following:

class BetaBase64PdfSource:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

title: Optional<String>

The title of the document

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

retrievedAt: Optional<String>

ISO 8601 timestamp when the content was retrieved

type: JsonValue;

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

url: String

Fetched content URL

toolUseId: String

type: JsonValue;

Accepts one of the following:

WEB_FETCH_TOOL_RESULT("web_fetch_tool_result")

class BetaCodeExecutionToolResultBlock:

Accepts one of the following:

class BetaCodeExecutionToolResultError: