Messages

Accepts one of the following:

class WebSearchToolResultError:

errorCode: ErrorCode

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 ContentBlockParam:

Regular text content.

class TextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<CacheControlEphemeral>

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<TextCitationParam>>

Accepts one of the following:

class CitationCharLocationParam:

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 CitationPageLocationParam:

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 CitationContentBlockLocationParam:

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 CitationWebSearchResultLocationParam:

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 CitationSearchResultLocationParam:

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 ImageBlockParam:

source: Source

Accepts one of the following:

class Base64ImageSource:

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 UrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<CacheControlEphemeral>

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 DocumentBlockParam:

source: Source

Accepts one of the following:

class Base64PdfSource:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class PlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

class ContentBlockSource:

content: Content

Accepts one of the following:

String

Accepts one of the following:

class TextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<CacheControlEphemeral>

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<TextCitationParam>>

Accepts one of the following:

class CitationCharLocationParam:

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 CitationPageLocationParam:

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 CitationContentBlockLocationParam:

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 CitationWebSearchResultLocationParam:

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 CitationSearchResultLocationParam:

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 ImageBlockParam:

source: Source

Accepts one of the following:

class Base64ImageSource:

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 UrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<CacheControlEphemeral>

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 UrlPdfSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

cacheControl: Optional<CacheControlEphemeral>

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<CitationsConfigParam>

enabled: Optional<Boolean>

context: Optional<String>

minLength1

title: Optional<String>

maxLength500

minLength1

class SearchResultBlockParam:

content: List<TextBlockParam>

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<CacheControlEphemeral>

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<TextCitationParam>>

Accepts one of the following:

class CitationCharLocationParam:

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 CitationPageLocationParam:

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 CitationContentBlockLocationParam:

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 CitationWebSearchResultLocationParam:

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 CitationSearchResultLocationParam:

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<CacheControlEphemeral>

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<CitationsConfigParam>

enabled: Optional<Boolean>

class ThinkingBlockParam:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class RedactedThinkingBlockParam:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class ToolUseBlockParam:

id: String

input: Input

maxLength200

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

cacheControl: Optional<CacheControlEphemeral>

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 ToolResultBlockParam:

toolUseId: String

type: JsonValue;

Accepts one of the following:

TOOL_RESULT("tool_result")

cacheControl: Optional<CacheControlEphemeral>

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 TextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<CacheControlEphemeral>

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<TextCitationParam>>

Accepts one of the following:

class CitationCharLocationParam:

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 CitationPageLocationParam:

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 CitationContentBlockLocationParam:

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 CitationWebSearchResultLocationParam:

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 CitationSearchResultLocationParam:

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 ImageBlockParam:

source: Source

Accepts one of the following:

class Base64ImageSource:

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 UrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<CacheControlEphemeral>

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 SearchResultBlockParam:

content: List<TextBlockParam>

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<CacheControlEphemeral>

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<TextCitationParam>>

Accepts one of the following:

class CitationCharLocationParam:

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 CitationPageLocationParam:

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 CitationContentBlockLocationParam:

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 CitationWebSearchResultLocationParam:

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 CitationSearchResultLocationParam:

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<CacheControlEphemeral>

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<CitationsConfigParam>

enabled: Optional<Boolean>

class DocumentBlockParam:

source: Source

Accepts one of the following:

class Base64PdfSource:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class PlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

class ContentBlockSource:

content: Content

Accepts one of the following:

String

Accepts one of the following:

class TextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<CacheControlEphemeral>

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<TextCitationParam>>

Accepts one of the following:

class CitationCharLocationParam:

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 CitationPageLocationParam:

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 CitationContentBlockLocationParam:

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 CitationWebSearchResultLocationParam:

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 CitationSearchResultLocationParam:

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 ImageBlockParam:

source: Source

Accepts one of the following:

class Base64ImageSource:

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 UrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<CacheControlEphemeral>

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 UrlPdfSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

cacheControl: Optional<CacheControlEphemeral>

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<CitationsConfigParam>

enabled: Optional<Boolean>

context: Optional<String>

minLength1

title: Optional<String>

maxLength500

minLength1

isError: Optional<Boolean>

class ServerToolUseBlockParam:

id: String

input: Input

Accepts one of the following:

WEB_SEARCH("web_search")

type: JsonValue;

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

cacheControl: Optional<CacheControlEphemeral>

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 WebSearchToolResultBlockParam:

content: WebSearchToolResultBlockParamContent

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 WebSearchToolRequestError:

errorCode: ErrorCode

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<CacheControlEphemeral>

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 ContentBlockSource:

content: Content

Accepts one of the following:

String

Accepts one of the following:

class TextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<CacheControlEphemeral>

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<TextCitationParam>>

Accepts one of the following:

class CitationCharLocationParam:

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 CitationPageLocationParam:

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 CitationContentBlockLocationParam:

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 CitationWebSearchResultLocationParam:

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 CitationSearchResultLocationParam:

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 ImageBlockParam:

source: Source

Accepts one of the following:

class Base64ImageSource:

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 UrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<CacheControlEphemeral>

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 ContentBlockSourceContent:

class TextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<CacheControlEphemeral>

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<TextCitationParam>>

Accepts one of the following:

class CitationCharLocationParam:

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 CitationPageLocationParam:

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 CitationContentBlockLocationParam:

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 CitationWebSearchResultLocationParam:

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 CitationSearchResultLocationParam:

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 ImageBlockParam:

source: Source

Accepts one of the following:

class Base64ImageSource:

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 UrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<CacheControlEphemeral>

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 DocumentBlockParam:

source: Source

Accepts one of the following:

class Base64PdfSource:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class PlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

class ContentBlockSource:

content: Content

Accepts one of the following:

String

Accepts one of the following:

class TextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<CacheControlEphemeral>

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<TextCitationParam>>

Accepts one of the following:

class CitationCharLocationParam:

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 CitationPageLocationParam:

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 CitationContentBlockLocationParam:

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 CitationWebSearchResultLocationParam:

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 CitationSearchResultLocationParam:

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 ImageBlockParam:

source: Source

Accepts one of the following:

class Base64ImageSource:

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 UrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<CacheControlEphemeral>

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 UrlPdfSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

cacheControl: Optional<CacheControlEphemeral>

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<CitationsConfigParam>

enabled: Optional<Boolean>

context: Optional<String>

minLength1

title: Optional<String>

maxLength500

minLength1

class ImageBlockParam:

source: Source

Accepts one of the following:

class Base64ImageSource:

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 UrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<CacheControlEphemeral>

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 InputJsonDelta:

partialJson: String

type: JsonValue;

Accepts one of the following:

INPUT_JSON_DELTA("input_json_delta")

class Message:

id: String

Unique object identifier.

The format and length of IDs may change over time.

content: List<ContentBlock>

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 TextBlock:

citations: Optional<List<TextCitation>>

Citations supporting the text block.

Accepts one of the following:

class CitationCharLocation:

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 CitationPageLocation:

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 CitationContentBlockLocation:

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 CitationsWebSearchResultLocation:

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 CitationsSearchResultLocation:

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 ThinkingBlock:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class RedactedThinkingBlock:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class ToolUseBlock:

id: String

input: Input

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

class ServerToolUseBlock:

id: String

input: Input

Accepts one of the following:

WEB_SEARCH("web_search")

type: JsonValue;

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

class WebSearchToolResultBlock:

Accepts one of the following:

class WebSearchToolResultError:

errorCode: ErrorCode

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

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<StopReason>

The reason that we stopped.

This may be one the following values:

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

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

Accepts one of the following:

END_TURN("end_turn")

MAX_TOKENS("max_tokens")

STOP_SEQUENCE("stop_sequence")

TOOL_USE("tool_use")

PAUSE_TURN("pause_turn")

REFUSAL("refusal")

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: Usage

Billing and rate-limit usage.

Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.

Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.

For example, output_tokens will be non-zero, even for an empty string response from Claude.

Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.

cacheCreation: Optional<CacheCreation>

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<ServerToolUsage>

The number of server tool requests.

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 MessageCountTokensTool:

class Tool:

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<CacheControlEphemeral>

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 ToolBash20250124:

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<CacheControlEphemeral>

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 ToolTextEditor20250124:

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<CacheControlEphemeral>

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 ToolTextEditor20250429:

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<CacheControlEphemeral>

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 ToolTextEditor20250728:

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<CacheControlEphemeral>

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 WebSearchTool20250305:

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<CacheControlEphemeral>

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 MessageDeltaUsage:

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<ServerToolUsage>

The number of server tool requests.

webSearchRequests: Long

The number of web search tool requests.

minimum0

class MessageParam:

content: Content

Accepts one of the following:

String

List<ContentBlockParam>

Accepts one of the following:

class TextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<CacheControlEphemeral>

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<TextCitationParam>>

Accepts one of the following:

class CitationCharLocationParam:

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 CitationPageLocationParam:

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 CitationContentBlockLocationParam:

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 CitationWebSearchResultLocationParam:

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 CitationSearchResultLocationParam:

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 ImageBlockParam:

source: Source

Accepts one of the following:

class Base64ImageSource:

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 UrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<CacheControlEphemeral>

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 DocumentBlockParam:

source: Source

Accepts one of the following:

class Base64PdfSource:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class PlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

class ContentBlockSource:

content: Content

Accepts one of the following:

String

Accepts one of the following:

class TextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<CacheControlEphemeral>

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<TextCitationParam>>

Accepts one of the following:

class CitationCharLocationParam:

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 CitationPageLocationParam:

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 CitationContentBlockLocationParam:

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 CitationWebSearchResultLocationParam:

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 CitationSearchResultLocationParam:

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 ImageBlockParam:

source: Source

Accepts one of the following:

class Base64ImageSource:

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 UrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<CacheControlEphemeral>

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 UrlPdfSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

cacheControl: Optional<CacheControlEphemeral>

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<CitationsConfigParam>

enabled: Optional<Boolean>

context: Optional<String>

minLength1

title: Optional<String>

maxLength500

minLength1

class SearchResultBlockParam:

content: List<TextBlockParam>

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<CacheControlEphemeral>

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<TextCitationParam>>

Accepts one of the following:

class CitationCharLocationParam:

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 CitationPageLocationParam:

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 CitationContentBlockLocationParam:

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 CitationWebSearchResultLocationParam:

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 CitationSearchResultLocationParam:

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<CacheControlEphemeral>

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<CitationsConfigParam>

enabled: Optional<Boolean>

class ThinkingBlockParam:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class RedactedThinkingBlockParam:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class ToolUseBlockParam:

id: String

input: Input

maxLength200

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

cacheControl: Optional<CacheControlEphemeral>

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 ToolResultBlockParam:

toolUseId: String

type: JsonValue;

Accepts one of the following:

TOOL_RESULT("tool_result")

cacheControl: Optional<CacheControlEphemeral>

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 TextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<CacheControlEphemeral>

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<TextCitationParam>>

Accepts one of the following:

class CitationCharLocationParam:

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 CitationPageLocationParam:

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 CitationContentBlockLocationParam:

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 CitationWebSearchResultLocationParam:

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 CitationSearchResultLocationParam:

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 ImageBlockParam:

source: Source

Accepts one of the following:

class Base64ImageSource:

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 UrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<CacheControlEphemeral>

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 SearchResultBlockParam:

content: List<TextBlockParam>

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<CacheControlEphemeral>

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<TextCitationParam>>

Accepts one of the following:

class CitationCharLocationParam:

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 CitationPageLocationParam:

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 CitationContentBlockLocationParam:

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 CitationWebSearchResultLocationParam:

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 CitationSearchResultLocationParam:

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<CacheControlEphemeral>

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<CitationsConfigParam>

enabled: Optional<Boolean>

class DocumentBlockParam:

source: Source

Accepts one of the following:

class Base64PdfSource:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class PlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

class ContentBlockSource:

content: Content

Accepts one of the following:

String

Accepts one of the following:

class TextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<CacheControlEphemeral>

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<TextCitationParam>>

Accepts one of the following:

class CitationCharLocationParam:

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 CitationPageLocationParam:

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 CitationContentBlockLocationParam:

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 CitationWebSearchResultLocationParam:

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 CitationSearchResultLocationParam:

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 ImageBlockParam:

source: Source

Accepts one of the following:

class Base64ImageSource:

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 UrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<CacheControlEphemeral>

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 UrlPdfSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

cacheControl: Optional<CacheControlEphemeral>

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<CitationsConfigParam>

enabled: Optional<Boolean>

context: Optional<String>

minLength1

title: Optional<String>

maxLength500

minLength1

isError: Optional<Boolean>

class ServerToolUseBlockParam:

id: String

input: Input

Accepts one of the following:

WEB_SEARCH("web_search")

type: JsonValue;

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

cacheControl: Optional<CacheControlEphemeral>

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 WebSearchToolResultBlockParam:

content: WebSearchToolResultBlockParamContent

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 WebSearchToolRequestError:

errorCode: ErrorCode

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<CacheControlEphemeral>

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 MessageTokensCount:

inputTokens: Long

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

class Metadata:

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 PlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

class RawContentBlockDelta:

class TextDelta:

text: String

type: JsonValue;

Accepts one of the following:

TEXT_DELTA("text_delta")

class InputJsonDelta:

partialJson: String

type: JsonValue;

Accepts one of the following:

INPUT_JSON_DELTA("input_json_delta")

class CitationsDelta:

citation: Citation

Accepts one of the following:

class CitationCharLocation:

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 CitationPageLocation:

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 CitationContentBlockLocation:

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 CitationsWebSearchResultLocation:

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 CitationsSearchResultLocation:

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 ThinkingDelta:

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING_DELTA("thinking_delta")

class SignatureDelta:

signature: String

type: JsonValue;

Accepts one of the following:

SIGNATURE_DELTA("signature_delta")

class RawContentBlockDeltaEvent:

delta: RawContentBlockDelta

Accepts one of the following:

class TextDelta:

text: String

type: JsonValue;

Accepts one of the following:

TEXT_DELTA("text_delta")

class InputJsonDelta:

partialJson: String

type: JsonValue;

Accepts one of the following:

INPUT_JSON_DELTA("input_json_delta")

class CitationsDelta:

citation: Citation

Accepts one of the following:

class CitationCharLocation:

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 CitationPageLocation:

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 CitationContentBlockLocation:

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 CitationsWebSearchResultLocation:

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 CitationsSearchResultLocation:

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 ThinkingDelta:

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING_DELTA("thinking_delta")

class SignatureDelta:

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 RawContentBlockStartEvent:

contentBlock: ContentBlock

Accepts one of the following:

class TextBlock:

citations: Optional<List<TextCitation>>

Citations supporting the text block.

Accepts one of the following:

class CitationCharLocation:

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 CitationPageLocation:

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 CitationContentBlockLocation:

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 CitationsWebSearchResultLocation:

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 CitationsSearchResultLocation:

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 ThinkingBlock:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class RedactedThinkingBlock:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class ToolUseBlock:

id: String

input: Input

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

class ServerToolUseBlock:

id: String

input: Input

Accepts one of the following:

WEB_SEARCH("web_search")

type: JsonValue;

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

class WebSearchToolResultBlock:

Accepts one of the following:

class WebSearchToolResultError:

errorCode: ErrorCode

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

index: Long

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_START("content_block_start")

class RawContentBlockStopEvent:

index: Long

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_STOP("content_block_stop")

class RawMessageDeltaEvent:

delta: Delta

stopReason: Optional<StopReason>

Accepts one of the following:

END_TURN("end_turn")

MAX_TOKENS("max_tokens")

STOP_SEQUENCE("stop_sequence")

TOOL_USE("tool_use")

PAUSE_TURN("pause_turn")

REFUSAL("refusal")

stopSequence: Optional<String>

type: JsonValue;

Accepts one of the following:

MESSAGE_DELTA("message_delta")

usage: MessageDeltaUsage

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<ServerToolUsage>

The number of server tool requests.

webSearchRequests: Long

The number of web search tool requests.

minimum0

class RawMessageStartEvent:

message: Message

id: String

Unique object identifier.

The format and length of IDs may change over time.

content: List<ContentBlock>

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 TextBlock:

citations: Optional<List<TextCitation>>

Citations supporting the text block.

Accepts one of the following:

class CitationCharLocation:

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 CitationPageLocation:

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 CitationContentBlockLocation:

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 CitationsWebSearchResultLocation:

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 CitationsSearchResultLocation:

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 ThinkingBlock:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class RedactedThinkingBlock:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class ToolUseBlock:

id: String

input: Input

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

class ServerToolUseBlock:

id: String

input: Input

Accepts one of the following:

WEB_SEARCH("web_search")

type: JsonValue;

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

class WebSearchToolResultBlock:

Accepts one of the following:

class WebSearchToolResultError:

errorCode: ErrorCode

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

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<StopReason>

The reason that we stopped.

This may be one the following values:

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

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

Accepts one of the following:

END_TURN("end_turn")

MAX_TOKENS("max_tokens")

STOP_SEQUENCE("stop_sequence")

TOOL_USE("tool_use")

PAUSE_TURN("pause_turn")

REFUSAL("refusal")

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: Usage

Billing and rate-limit usage.

Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.

For example, output_tokens will be non-zero, even for an empty string response from Claude.

Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.

cacheCreation: Optional<CacheCreation>

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<ServerToolUsage>

The number of server tool requests.

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 RawMessageStopEvent:

type: JsonValue;

Accepts one of the following:

MESSAGE_STOP("message_stop")

class RawMessageStreamEvent:

class RawMessageStartEvent:

message: Message

id: String

Unique object identifier.

The format and length of IDs may change over time.

content: List<ContentBlock>

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 TextBlock:

citations: Optional<List<TextCitation>>

Citations supporting the text block.

Accepts one of the following:

class CitationCharLocation:

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 CitationPageLocation:

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 CitationContentBlockLocation:

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 CitationsWebSearchResultLocation:

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 CitationsSearchResultLocation:

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 ThinkingBlock:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class RedactedThinkingBlock:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class ToolUseBlock:

id: String

input: Input

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

class ServerToolUseBlock:

id: String

input: Input

Accepts one of the following:

WEB_SEARCH("web_search")

type: JsonValue;

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

class WebSearchToolResultBlock:

Accepts one of the following:

class WebSearchToolResultError:

errorCode: ErrorCode

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

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<StopReason>

The reason that we stopped.

This may be one the following values:

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

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

Accepts one of the following:

END_TURN("end_turn")

MAX_TOKENS("max_tokens")

STOP_SEQUENCE("stop_sequence")

TOOL_USE("tool_use")

PAUSE_TURN("pause_turn")

REFUSAL("refusal")

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: Usage

Billing and rate-limit usage.

Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.

For example, output_tokens will be non-zero, even for an empty string response from Claude.

Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.

cacheCreation: Optional<CacheCreation>

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<ServerToolUsage>

The number of server tool requests.

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 RawMessageDeltaEvent:

delta: Delta

stopReason: Optional<StopReason>

Accepts one of the following:

END_TURN("end_turn")

MAX_TOKENS("max_tokens")

STOP_SEQUENCE("stop_sequence")

TOOL_USE("tool_use")

PAUSE_TURN("pause_turn")

REFUSAL("refusal")

stopSequence: Optional<String>

type: JsonValue;

Accepts one of the following:

MESSAGE_DELTA("message_delta")

usage: MessageDeltaUsage

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<ServerToolUsage>

The number of server tool requests.

webSearchRequests: Long

The number of web search tool requests.

minimum0

class RawMessageStopEvent:

type: JsonValue;

Accepts one of the following:

MESSAGE_STOP("message_stop")

class RawContentBlockStartEvent:

contentBlock: ContentBlock

Accepts one of the following:

class TextBlock:

citations: Optional<List<TextCitation>>

Citations supporting the text block.

Accepts one of the following:

class CitationCharLocation:

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 CitationPageLocation:

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 CitationContentBlockLocation:

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 CitationsWebSearchResultLocation:

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 CitationsSearchResultLocation:

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 ThinkingBlock:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class RedactedThinkingBlock:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class ToolUseBlock:

id: String

input: Input

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

class ServerToolUseBlock:

id: String

input: Input

Accepts one of the following:

WEB_SEARCH("web_search")

type: JsonValue;

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

class WebSearchToolResultBlock:

Accepts one of the following:

class WebSearchToolResultError:

errorCode: ErrorCode

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

index: Long

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_START("content_block_start")

class RawContentBlockDeltaEvent:

delta: RawContentBlockDelta

Accepts one of the following:

class TextDelta:

text: String

type: JsonValue;

Accepts one of the following:

TEXT_DELTA("text_delta")

class InputJsonDelta:

partialJson: String

type: JsonValue;

Accepts one of the following:

INPUT_JSON_DELTA("input_json_delta")

class CitationsDelta:

citation: Citation

Accepts one of the following:

class CitationCharLocation:

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 CitationPageLocation:

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 CitationContentBlockLocation:

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 CitationsWebSearchResultLocation:

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 CitationsSearchResultLocation:

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 ThinkingDelta:

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING_DELTA("thinking_delta")

class SignatureDelta:

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 RawContentBlockStopEvent:

index: Long

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_STOP("content_block_stop")

class RedactedThinkingBlock:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class RedactedThinkingBlockParam:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class SearchResultBlockParam:

content: List<TextBlockParam>

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<CacheControlEphemeral>

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<TextCitationParam>>

Accepts one of the following:

class CitationCharLocationParam:

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 CitationPageLocationParam:

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 CitationContentBlockLocationParam:

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 CitationWebSearchResultLocationParam:

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 CitationSearchResultLocationParam:

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<CacheControlEphemeral>

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<CitationsConfigParam>

enabled: Optional<Boolean>

class ServerToolUsage:

webSearchRequests: Long

The number of web search tool requests.

minimum0

class ServerToolUseBlock:

id: String

input: Input

Accepts one of the following:

WEB_SEARCH("web_search")

type: JsonValue;

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

class ServerToolUseBlockParam:

id: String

input: Input

Accepts one of the following:

WEB_SEARCH("web_search")

type: JsonValue;

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

cacheControl: Optional<CacheControlEphemeral>

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 SignatureDelta:

signature: String

type: JsonValue;

Accepts one of the following:

SIGNATURE_DELTA("signature_delta")

enum class StopReason:

END_TURN("end_turn")

MAX_TOKENS("max_tokens")

STOP_SEQUENCE("stop_sequence")

TOOL_USE("tool_use")

PAUSE_TURN("pause_turn")

REFUSAL("refusal")

class TextBlock:

citations: Optional<List<TextCitation>>

Citations supporting the text block.

Accepts one of the following:

class CitationCharLocation:

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 CitationPageLocation:

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 CitationContentBlockLocation:

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 CitationsWebSearchResultLocation:

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 CitationsSearchResultLocation:

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 TextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<CacheControlEphemeral>

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<TextCitationParam>>

Accepts one of the following:

class CitationCharLocationParam:

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 CitationPageLocationParam:

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 CitationContentBlockLocationParam:

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 CitationWebSearchResultLocationParam:

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 CitationSearchResultLocationParam:

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 TextCitation:

class CitationCharLocation:

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 CitationPageLocation:

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 CitationContentBlockLocation:

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 CitationsWebSearchResultLocation:

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 CitationsSearchResultLocation:

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 TextCitationParam:

class CitationCharLocationParam:

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 CitationPageLocationParam:

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 CitationContentBlockLocationParam:

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 CitationWebSearchResultLocationParam:

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 CitationSearchResultLocationParam:

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 TextDelta:

text: String

type: JsonValue;

Accepts one of the following:

TEXT_DELTA("text_delta")

class ThinkingBlock:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class ThinkingBlockParam:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class ThinkingConfigDisabled:

type: JsonValue;

Accepts one of the following:

DISABLED("disabled")

class ThinkingConfigEnabled:

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 ThinkingConfigParam:

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 ThinkingConfigEnabled:

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 ThinkingConfigDisabled:

type: JsonValue;

Accepts one of the following:

DISABLED("disabled")

class ThinkingDelta:

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING_DELTA("thinking_delta")

class Tool:

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<CacheControlEphemeral>

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 ToolBash20250124:

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<CacheControlEphemeral>

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 ToolChoice:

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 ToolChoiceAuto:

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 ToolChoiceAny:

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 ToolChoiceTool:

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 ToolChoiceNone:

The model will not be allowed to use tools.

type: JsonValue;

Accepts one of the following:

NONE("none")

class ToolChoiceAny:

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 ToolChoiceAuto:

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 ToolChoiceNone:

The model will not be allowed to use tools.

type: JsonValue;

Accepts one of the following:

NONE("none")

class ToolChoiceTool:

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 ToolResultBlockParam:

toolUseId: String

type: JsonValue;

Accepts one of the following:

TOOL_RESULT("tool_result")

cacheControl: Optional<CacheControlEphemeral>

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 TextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<CacheControlEphemeral>

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<TextCitationParam>>

Accepts one of the following:

class CitationCharLocationParam:

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 CitationPageLocationParam:

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 CitationContentBlockLocationParam:

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 CitationWebSearchResultLocationParam:

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 CitationSearchResultLocationParam:

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 ImageBlockParam:

source: Source

Accepts one of the following:

class Base64ImageSource:

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 UrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<CacheControlEphemeral>

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 SearchResultBlockParam:

content: List<TextBlockParam>

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<CacheControlEphemeral>

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<TextCitationParam>>

Accepts one of the following:

class CitationCharLocationParam:

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 CitationPageLocationParam:

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 CitationContentBlockLocationParam:

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 CitationWebSearchResultLocationParam:

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 CitationSearchResultLocationParam:

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<CacheControlEphemeral>

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<CitationsConfigParam>

enabled: Optional<Boolean>

class DocumentBlockParam:

source: Source

Accepts one of the following:

class Base64PdfSource:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class PlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

class ContentBlockSource:

content: Content

Accepts one of the following:

String

Accepts one of the following:

class TextBlockParam:

text: String

minLength1

type: JsonValue;

Accepts one of the following:

TEXT("text")

cacheControl: Optional<CacheControlEphemeral>

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<TextCitationParam>>

Accepts one of the following:

class CitationCharLocationParam:

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 CitationPageLocationParam:

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 CitationContentBlockLocationParam:

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 CitationWebSearchResultLocationParam:

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 CitationSearchResultLocationParam:

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 ImageBlockParam:

source: Source

Accepts one of the following:

class Base64ImageSource:

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 UrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

type: JsonValue;

Accepts one of the following:

IMAGE("image")

cacheControl: Optional<CacheControlEphemeral>

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 UrlPdfSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

cacheControl: Optional<CacheControlEphemeral>

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<CitationsConfigParam>

enabled: Optional<Boolean>

context: Optional<String>

minLength1

title: Optional<String>

maxLength500

minLength1

isError: Optional<Boolean>

class ToolTextEditor20250124:

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<CacheControlEphemeral>

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 ToolTextEditor20250429:

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<CacheControlEphemeral>

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 ToolTextEditor20250728:

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<CacheControlEphemeral>

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 ToolUnion:

class Tool:

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<CacheControlEphemeral>

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 ToolBash20250124:

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<CacheControlEphemeral>

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 ToolTextEditor20250124:

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<CacheControlEphemeral>

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 ToolTextEditor20250429:

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<CacheControlEphemeral>

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 ToolTextEditor20250728:

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<CacheControlEphemeral>

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 WebSearchTool20250305:

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<CacheControlEphemeral>

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 ToolUseBlock:

id: String

input: Input

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

class ToolUseBlockParam:

id: String

input: Input

maxLength200

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

cacheControl: Optional<CacheControlEphemeral>

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 UrlImageSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class UrlPdfSource:

type: JsonValue;

Accepts one of the following:

URL("url")

url: String

class Usage:

cacheCreation: Optional<CacheCreation>

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<ServerToolUsage>

The number of server tool requests.

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 WebSearchResultBlock:

encryptedContent: String

pageAge: Optional<String>

title: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

url: String

class WebSearchResultBlockParam:

encryptedContent: String

title: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

url: String

pageAge: Optional<String>

class WebSearchTool20250305:

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<CacheControlEphemeral>

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 WebSearchToolRequestError:

errorCode: ErrorCode

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 WebSearchToolResultBlock:

Accepts one of the following:

class WebSearchToolResultError:

errorCode: ErrorCode

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 WebSearchToolResultBlockContent:

class WebSearchToolResultError:

errorCode: ErrorCode

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 WebSearchToolResultBlockParam:

content: WebSearchToolResultBlockParamContent

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 WebSearchToolRequestError:

errorCode: ErrorCode

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<CacheControlEphemeral>

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 WebSearchToolResultBlockParamContent:

encryptedContent: String

title: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

url: String

pageAge: Optional<String>

class WebSearchToolRequestError:

errorCode: ErrorCode

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 WebSearchToolResultError:

errorCode: ErrorCode

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

MessagesBatches

Cancel a Message Batch

messages().batches().cancel(, ) : MessageBatch

post/v1/messages/batches/{message_batch_id}/cancel

Create a Message Batch

messages().batches().create(, ) : MessageBatch

post/v1/messages/batches

Delete a Message Batch

messages().batches().delete(, ) : DeletedMessageBatch

delete/v1/messages/batches/{message_batch_id}

List Message Batches

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

get/v1/messages/batches

Retrieve Message Batch results

messages().batches().resultsStreaming(, ) : MessageBatchIndividualResponse

get/v1/messages/batches/{message_batch_id}/results

Retrieve a Message Batch

messages().batches().retrieve(, ) : MessageBatch

get/v1/messages/batches/{message_batch_id}

ModelsExpand Collapse

class DeletedMessageBatch:

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 MessageBatch:

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: MessageBatchRequestCounts

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 MessageBatchCanceledResult:

type: JsonValue;

Accepts one of the following:

CANCELED("canceled")

class MessageBatchErroredResult:

error: ErrorResponse

error: ErrorObject

Accepts one of the following:

class InvalidRequestError:

message: String

type: JsonValue;

Accepts one of the following:

INVALID_REQUEST_ERROR("invalid_request_error")

class AuthenticationError:

message: String

type: JsonValue;

Accepts one of the following:

AUTHENTICATION_ERROR("authentication_error")

class BillingError:

message: String

type: JsonValue;

Accepts one of the following:

BILLING_ERROR("billing_error")

class PermissionError:

message: String

type: JsonValue;

Accepts one of the following:

PERMISSION_ERROR("permission_error")

class NotFoundError:

message: String

type: JsonValue;

Accepts one of the following:

NOT_FOUND_ERROR("not_found_error")

class RateLimitError:

message: String

type: JsonValue;

Accepts one of the following:

RATE_LIMIT_ERROR("rate_limit_error")

class GatewayTimeoutError:

message: String

type: JsonValue;

Accepts one of the following:

TIMEOUT_ERROR("timeout_error")

class ApiErrorObject:

message: String

type: JsonValue;

Accepts one of the following:

API_ERROR("api_error")

class OverloadedError:

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 MessageBatchExpiredResult:

type: JsonValue;

Accepts one of the following:

EXPIRED("expired")

class MessageBatchIndividualResponse:

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: MessageBatchResult

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 MessageBatchSucceededResult:

message: Message

id: String

Unique object identifier.

The format and length of IDs may change over time.

content: List<ContentBlock>

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 TextBlock:

citations: Optional<List<TextCitation>>

Citations supporting the text block.

Accepts one of the following:

class CitationCharLocation:

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 CitationPageLocation:

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 CitationContentBlockLocation:

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 CitationsWebSearchResultLocation:

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 CitationsSearchResultLocation:

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 ThinkingBlock:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class RedactedThinkingBlock:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class ToolUseBlock:

id: String

input: Input

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

class ServerToolUseBlock:

id: String

input: Input

Accepts one of the following:

WEB_SEARCH("web_search")

type: JsonValue;

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

class WebSearchToolResultBlock:

Accepts one of the following:

class WebSearchToolResultError:

errorCode: ErrorCode

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

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<StopReason>

The reason that we stopped.

This may be one the following values:

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

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

Accepts one of the following:

END_TURN("end_turn")

MAX_TOKENS("max_tokens")

STOP_SEQUENCE("stop_sequence")

TOOL_USE("tool_use")

PAUSE_TURN("pause_turn")

REFUSAL("refusal")

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: Usage

Billing and rate-limit usage.

Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.

For example, output_tokens will be non-zero, even for an empty string response from Claude.

Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.

cacheCreation: Optional<CacheCreation>

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<ServerToolUsage>

The number of server tool requests.

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 MessageBatchErroredResult:

error: ErrorResponse

error: ErrorObject

Accepts one of the following:

class InvalidRequestError:

message: String

type: JsonValue;

Accepts one of the following:

INVALID_REQUEST_ERROR("invalid_request_error")

class AuthenticationError:

message: String

type: JsonValue;

Accepts one of the following:

AUTHENTICATION_ERROR("authentication_error")

class BillingError:

message: String

type: JsonValue;

Accepts one of the following:

BILLING_ERROR("billing_error")

class PermissionError:

message: String

type: JsonValue;

Accepts one of the following:

PERMISSION_ERROR("permission_error")

class NotFoundError:

message: String

type: JsonValue;

Accepts one of the following:

NOT_FOUND_ERROR("not_found_error")

class RateLimitError:

message: String

type: JsonValue;

Accepts one of the following:

RATE_LIMIT_ERROR("rate_limit_error")

class GatewayTimeoutError:

message: String

type: JsonValue;

Accepts one of the following:

TIMEOUT_ERROR("timeout_error")

class ApiErrorObject:

message: String

type: JsonValue;

Accepts one of the following:

API_ERROR("api_error")

class OverloadedError:

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 MessageBatchCanceledResult:

type: JsonValue;

Accepts one of the following:

CANCELED("canceled")

class MessageBatchExpiredResult:

type: JsonValue;

Accepts one of the following:

EXPIRED("expired")

class MessageBatchRequestCounts:

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 MessageBatchResult:

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 MessageBatchSucceededResult:

message: Message

id: String

Unique object identifier.

The format and length of IDs may change over time.

content: List<ContentBlock>

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 TextBlock:

citations: Optional<List<TextCitation>>

Citations supporting the text block.

Accepts one of the following:

class CitationCharLocation:

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 CitationPageLocation:

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 CitationContentBlockLocation:

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 CitationsWebSearchResultLocation:

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 CitationsSearchResultLocation:

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 ThinkingBlock:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class RedactedThinkingBlock:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class ToolUseBlock:

id: String

input: Input

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

class ServerToolUseBlock:

id: String

input: Input

Accepts one of the following:

WEB_SEARCH("web_search")

type: JsonValue;

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

class WebSearchToolResultBlock:

Accepts one of the following:

class WebSearchToolResultError:

errorCode: ErrorCode

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

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<StopReason>

The reason that we stopped.

This may be one the following values:

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

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

Accepts one of the following:

END_TURN("end_turn")

MAX_TOKENS("max_tokens")

STOP_SEQUENCE("stop_sequence")

TOOL_USE("tool_use")

PAUSE_TURN("pause_turn")

REFUSAL("refusal")

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: Usage

Billing and rate-limit usage.

Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.

For example, output_tokens will be non-zero, even for an empty string response from Claude.

Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.

cacheCreation: Optional<CacheCreation>

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<ServerToolUsage>

The number of server tool requests.

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 MessageBatchErroredResult:

error: ErrorResponse

error: ErrorObject

Accepts one of the following:

class InvalidRequestError:

message: String

type: JsonValue;

Accepts one of the following:

INVALID_REQUEST_ERROR("invalid_request_error")

class AuthenticationError:

message: String

type: JsonValue;

Accepts one of the following:

AUTHENTICATION_ERROR("authentication_error")

class BillingError:

message: String

type: JsonValue;

Accepts one of the following:

BILLING_ERROR("billing_error")

class PermissionError:

message: String

type: JsonValue;

Accepts one of the following:

PERMISSION_ERROR("permission_error")

class NotFoundError:

message: String

type: JsonValue;

Accepts one of the following:

NOT_FOUND_ERROR("not_found_error")

class RateLimitError:

message: String

type: JsonValue;

Accepts one of the following:

RATE_LIMIT_ERROR("rate_limit_error")

class GatewayTimeoutError:

message: String

type: JsonValue;

Accepts one of the following:

TIMEOUT_ERROR("timeout_error")

class ApiErrorObject:

message: String

type: JsonValue;

Accepts one of the following:

API_ERROR("api_error")

class OverloadedError:

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 MessageBatchCanceledResult:

type: JsonValue;

Accepts one of the following:

CANCELED("canceled")

class MessageBatchExpiredResult:

type: JsonValue;

Accepts one of the following:

EXPIRED("expired")

class MessageBatchSucceededResult:

message: Message

id: String

Unique object identifier.

The format and length of IDs may change over time.

content: List<ContentBlock>

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 TextBlock:

citations: Optional<List<TextCitation>>

Citations supporting the text block.

Accepts one of the following:

class CitationCharLocation:

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 CitationPageLocation:

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 CitationContentBlockLocation:

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 CitationsWebSearchResultLocation:

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 CitationsSearchResultLocation:

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 ThinkingBlock:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class RedactedThinkingBlock:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class ToolUseBlock:

id: String

input: Input

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

class ServerToolUseBlock:

id: String

input: Input

Accepts one of the following:

WEB_SEARCH("web_search")

type: JsonValue;

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

class WebSearchToolResultBlock:

Accepts one of the following:

class WebSearchToolResultError:

errorCode: ErrorCode

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