Messages
Count tokens in a Message
client.Beta.Messages.CountTokens(ctx, params) (*BetaMessageTokensCount, error)
post/v1/messages/count_tokens
ModelsExpand Collapse
type BetaAllThinkingTurns struct{…}
type BetaAllThinkingTurns struct{…}
Type All
Type All
Accepts one of the following:
const AllAll All = "all"
type BetaBase64ImageSource struct{…}
type BetaBase64ImageSource struct{…}
Data string
MediaType BetaBase64ImageSourceMediaType
MediaType BetaBase64ImageSourceMediaType
Accepts one of the following:
const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"
const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"
const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"
const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaBase64PDFSource struct{…}
type BetaBase64PDFSource struct{…}
Data string
MediaType ApplicationPDF
MediaType ApplicationPDF
Accepts one of the following:
const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaBashCodeExecutionOutputBlock struct{…}
type BetaBashCodeExecutionOutputBlock struct{…}
FileID string
Type BashCodeExecutionOutput
Type BashCodeExecutionOutput
Accepts one of the following:
const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"
type BetaBashCodeExecutionOutputBlockParamResp struct{…}
type BetaBashCodeExecutionOutputBlockParamResp struct{…}
FileID string
Type BashCodeExecutionOutput
Type BashCodeExecutionOutput
Accepts one of the following:
const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"
type BetaBashCodeExecutionResultBlock struct{…}
type BetaBashCodeExecutionResultBlock struct{…}
Content []BetaBashCodeExecutionOutputBlock
Content []BetaBashCodeExecutionOutputBlock
FileID string
Type BashCodeExecutionOutput
Type BashCodeExecutionOutput
Accepts one of the following:
const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type BashCodeExecutionResult
Type BashCodeExecutionResult
Accepts one of the following:
const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"
type BetaBashCodeExecutionResultBlockParamResp struct{…}
type BetaBashCodeExecutionResultBlockParamResp struct{…}
FileID string
Type BashCodeExecutionOutput
Type BashCodeExecutionOutput
Accepts one of the following:
const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type BashCodeExecutionResult
Type BashCodeExecutionResult
Accepts one of the following:
const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"
type BetaBashCodeExecutionToolResultBlock struct{…}
type BetaBashCodeExecutionToolResultBlock struct{…}
Content BetaBashCodeExecutionToolResultBlockContentUnion
Content BetaBashCodeExecutionToolResultBlockContentUnion
Accepts one of the following:
type BetaBashCodeExecutionToolResultError struct{…}
type BetaBashCodeExecutionToolResultError struct{…}
ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode
ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode
Accepts one of the following:
const BetaBashCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"
const BetaBashCodeExecutionToolResultErrorErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorErrorCode = "unavailable"
const BetaBashCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorErrorCode = "too_many_requests"
const BetaBashCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"
const BetaBashCodeExecutionToolResultErrorErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorErrorCode = "output_file_too_large"
Type BashCodeExecutionToolResultError
Type BashCodeExecutionToolResultError
Accepts one of the following:
const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"
type BetaBashCodeExecutionResultBlock struct{…}
type BetaBashCodeExecutionResultBlock struct{…}
Content []BetaBashCodeExecutionOutputBlock
Content []BetaBashCodeExecutionOutputBlock
FileID string
Type BashCodeExecutionOutput
Type BashCodeExecutionOutput
Accepts one of the following:
const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type BashCodeExecutionResult
Type BashCodeExecutionResult
Accepts one of the following:
const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"
ToolUseID string
Type BashCodeExecutionToolResult
Type BashCodeExecutionToolResult
Accepts one of the following:
const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"
type BetaBashCodeExecutionToolResultBlockParamResp struct{…}
type BetaBashCodeExecutionToolResultBlockParamResp struct{…}
Content BetaBashCodeExecutionToolResultBlockParamContentUnionResp
Content BetaBashCodeExecutionToolResultBlockParamContentUnionResp
Accepts one of the following:
type BetaBashCodeExecutionToolResultErrorParamResp struct{…}
type BetaBashCodeExecutionToolResultErrorParamResp struct{…}
ErrorCode BetaBashCodeExecutionToolResultErrorParamErrorCode
ErrorCode BetaBashCodeExecutionToolResultErrorParamErrorCode
Accepts one of the following:
const BetaBashCodeExecutionToolResultErrorParamErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorParamErrorCode = "invalid_tool_input"
const BetaBashCodeExecutionToolResultErrorParamErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorParamErrorCode = "unavailable"
const BetaBashCodeExecutionToolResultErrorParamErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorParamErrorCode = "too_many_requests"
const BetaBashCodeExecutionToolResultErrorParamErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorParamErrorCode = "execution_time_exceeded"
const BetaBashCodeExecutionToolResultErrorParamErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorParamErrorCode = "output_file_too_large"
Type BashCodeExecutionToolResultError
Type BashCodeExecutionToolResultError
Accepts one of the following:
const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"
type BetaBashCodeExecutionResultBlockParamResp struct{…}
type BetaBashCodeExecutionResultBlockParamResp struct{…}
FileID string
Type BashCodeExecutionOutput
Type BashCodeExecutionOutput
Accepts one of the following:
const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type BashCodeExecutionResult
Type BashCodeExecutionResult
Accepts one of the following:
const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"
ToolUseID string
Type BashCodeExecutionToolResult
Type BashCodeExecutionToolResult
Accepts one of the following:
const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaBashCodeExecutionToolResultError struct{…}
type BetaBashCodeExecutionToolResultError struct{…}
ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode
ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode
Accepts one of the following:
const BetaBashCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"
const BetaBashCodeExecutionToolResultErrorErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorErrorCode = "unavailable"
const BetaBashCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorErrorCode = "too_many_requests"
const BetaBashCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"
const BetaBashCodeExecutionToolResultErrorErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorErrorCode = "output_file_too_large"
Type BashCodeExecutionToolResultError
Type BashCodeExecutionToolResultError
Accepts one of the following:
const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"
type BetaBashCodeExecutionToolResultErrorParamResp struct{…}
type BetaBashCodeExecutionToolResultErrorParamResp struct{…}
ErrorCode BetaBashCodeExecutionToolResultErrorParamErrorCode
ErrorCode BetaBashCodeExecutionToolResultErrorParamErrorCode
Accepts one of the following:
const BetaBashCodeExecutionToolResultErrorParamErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorParamErrorCode = "invalid_tool_input"
const BetaBashCodeExecutionToolResultErrorParamErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorParamErrorCode = "unavailable"
const BetaBashCodeExecutionToolResultErrorParamErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorParamErrorCode = "too_many_requests"
const BetaBashCodeExecutionToolResultErrorParamErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorParamErrorCode = "execution_time_exceeded"
const BetaBashCodeExecutionToolResultErrorParamErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorParamErrorCode = "output_file_too_large"
Type BashCodeExecutionToolResultError
Type BashCodeExecutionToolResultError
Accepts one of the following:
const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"
type BetaCacheControlEphemeral struct{…}
type BetaCacheControlEphemeral struct{…}
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaCacheCreation struct{…}
type BetaCacheCreation struct{…}
Ephemeral1hInputTokens int64
Ephemeral1hInputTokens int64
The number of input tokens used to create the 1 hour cache entry.
minimum0
Ephemeral5mInputTokens int64
Ephemeral5mInputTokens int64
The number of input tokens used to create the 5 minute cache entry.
minimum0
type BetaCitationCharLocation struct{…}
type BetaCitationCharLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
FileID string
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationConfig struct{…}
type BetaCitationConfig struct{…}
Enabled bool
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationsConfigParamResp struct{…}
type BetaCitationsConfigParamResp struct{…}
Enabled booloptional
type BetaCitationsDelta struct{…}
type BetaCitationsDelta struct{…}
Citation BetaCitationsDeltaCitationUnion
Citation BetaCitationsDeltaCitationUnion
Accepts one of the following:
type BetaCitationCharLocation struct{…}
type BetaCitationCharLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
FileID string
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Type CitationsDelta
Type CitationsDelta
Accepts one of the following:
const CitationsDeltaCitationsDelta CitationsDelta = "citations_delta"
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaClearThinking20251015Edit struct{…}
type BetaClearThinking20251015Edit struct{…}
Type ClearThinking20251015
Type ClearThinking20251015
Accepts one of the following:
const ClearThinking20251015ClearThinking20251015 ClearThinking20251015 = "clear_thinking_20251015"
Keep BetaClearThinking20251015EditKeepUnionoptional
Keep BetaClearThinking20251015EditKeepUnionoptional
Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed.
Accepts one of the following:
type BetaThinkingTurns struct{…}
type BetaThinkingTurns struct{…}
Type ThinkingTurns
Type ThinkingTurns
Accepts one of the following:
const ThinkingTurnsThinkingTurns ThinkingTurns = "thinking_turns"
Value int64
type BetaAllThinkingTurns struct{…}
type BetaAllThinkingTurns struct{…}
Type All
Type All
Accepts one of the following:
const AllAll All = "all"
All
All
Accepts one of the following:
const AllAll All = "all"
type BetaClearThinking20251015EditResponse struct{…}
type BetaClearThinking20251015EditResponse struct{…}
ClearedInputTokens int64
ClearedInputTokens int64
Number of input tokens cleared by this edit.
minimum0
ClearedThinkingTurns int64
ClearedThinkingTurns int64
Number of thinking turns that were cleared.
minimum0
Type ClearThinking20251015
Type ClearThinking20251015
The type of context management edit applied.
Accepts one of the following:
const ClearThinking20251015ClearThinking20251015 ClearThinking20251015 = "clear_thinking_20251015"
type BetaClearToolUses20250919Edit struct{…}
type BetaClearToolUses20250919Edit struct{…}
Type ClearToolUses20250919
Type ClearToolUses20250919
Accepts one of the following:
const ClearToolUses20250919ClearToolUses20250919 ClearToolUses20250919 = "clear_tool_uses_20250919"
Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed.
Type InputTokens
Type InputTokens
Accepts one of the following:
const InputTokensInputTokens InputTokens = "input_tokens"
Value int64
ClearToolInputs BetaClearToolUses20250919EditClearToolInputsUnionoptional
ClearToolInputs BetaClearToolUses20250919EditClearToolInputsUnionoptional
Whether to clear all tool inputs (bool) or specific tool inputs to clear (list)
Accepts one of the following:
bool
[]string
ExcludeTools []stringoptional
ExcludeTools []stringoptional
Tool names whose uses are preserved from clearing
Number of tool uses to retain in the conversation
Type ToolUses
Type ToolUses
Accepts one of the following:
const ToolUsesToolUses ToolUses = "tool_uses"
Value int64
Trigger BetaClearToolUses20250919EditTriggerUnionoptional
Trigger BetaClearToolUses20250919EditTriggerUnionoptional
Condition that triggers the context management strategy
Accepts one of the following:
type BetaInputTokensTrigger struct{…}
type BetaInputTokensTrigger struct{…}
Type InputTokens
Type InputTokens
Accepts one of the following:
const InputTokensInputTokens InputTokens = "input_tokens"
Value int64
type BetaToolUsesTrigger struct{…}
type BetaToolUsesTrigger struct{…}
Type ToolUses
Type ToolUses
Accepts one of the following:
const ToolUsesToolUses ToolUses = "tool_uses"
Value int64
type BetaClearToolUses20250919EditResponse struct{…}
type BetaClearToolUses20250919EditResponse struct{…}
ClearedInputTokens int64
ClearedInputTokens int64
Number of input tokens cleared by this edit.
minimum0
ClearedToolUses int64
ClearedToolUses int64
Number of tool uses that were cleared.
minimum0
Type ClearToolUses20250919
Type ClearToolUses20250919
The type of context management edit applied.
Accepts one of the following:
const ClearToolUses20250919ClearToolUses20250919 ClearToolUses20250919 = "clear_tool_uses_20250919"
type BetaCodeExecutionOutputBlock struct{…}
type BetaCodeExecutionOutputBlock struct{…}
FileID string
Type CodeExecutionOutput
Type CodeExecutionOutput
Accepts one of the following:
const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"
type BetaCodeExecutionOutputBlockParamResp struct{…}
type BetaCodeExecutionOutputBlockParamResp struct{…}
FileID string
Type CodeExecutionOutput
Type CodeExecutionOutput
Accepts one of the following:
const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"
type BetaCodeExecutionResultBlock struct{…}
type BetaCodeExecutionResultBlock struct{…}
Content []BetaCodeExecutionOutputBlock
Content []BetaCodeExecutionOutputBlock
FileID string
Type CodeExecutionOutput
Type CodeExecutionOutput
Accepts one of the following:
const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type CodeExecutionResult
Type CodeExecutionResult
Accepts one of the following:
const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"
type BetaCodeExecutionResultBlockParamResp struct{…}
type BetaCodeExecutionResultBlockParamResp struct{…}
Content []BetaCodeExecutionOutputBlockParamResp
Content []BetaCodeExecutionOutputBlockParamResp
FileID string
Type CodeExecutionOutput
Type CodeExecutionOutput
Accepts one of the following:
const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type CodeExecutionResult
Type CodeExecutionResult
Accepts one of the following:
const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"
type BetaCodeExecutionTool20250522 struct{…}
type BetaCodeExecutionTool20250522 struct{…}
Name CodeExecution
Name CodeExecution
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:
const CodeExecutionCodeExecution CodeExecution = "code_execution"
Type CodeExecution20250522
Type CodeExecution20250522
Accepts one of the following:
const CodeExecution20250522CodeExecution20250522 CodeExecution20250522 = "code_execution_20250522"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"
const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Strict booloptional
type BetaCodeExecutionTool20250825 struct{…}
type BetaCodeExecutionTool20250825 struct{…}
Name CodeExecution
Name CodeExecution
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:
const CodeExecutionCodeExecution CodeExecution = "code_execution"
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"
const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Strict booloptional
type BetaCodeExecutionToolResultBlock struct{…}
type BetaCodeExecutionToolResultBlock struct{…}
Accepts one of the following:
type BetaCodeExecutionToolResultError struct{…}
type BetaCodeExecutionToolResultError struct{…}
ErrorCode BetaCodeExecutionToolResultErrorCode
ErrorCode BetaCodeExecutionToolResultErrorCode
Accepts one of the following:
const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"
const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"
const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"
const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"
Type CodeExecutionToolResultError
Type CodeExecutionToolResultError
Accepts one of the following:
const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"
type BetaCodeExecutionResultBlock struct{…}
type BetaCodeExecutionResultBlock struct{…}
Content []BetaCodeExecutionOutputBlock
Content []BetaCodeExecutionOutputBlock
FileID string
Type CodeExecutionOutput
Type CodeExecutionOutput
Accepts one of the following:
const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type CodeExecutionResult
Type CodeExecutionResult
Accepts one of the following:
const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"
ToolUseID string
Type CodeExecutionToolResult
Type CodeExecutionToolResult
Accepts one of the following:
const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"
type BetaCodeExecutionToolResultBlockContentUnion interface{…}
type BetaCodeExecutionToolResultBlockContentUnion interface{…}
Accepts one of the following:
type BetaCodeExecutionToolResultError struct{…}
type BetaCodeExecutionToolResultError struct{…}
ErrorCode BetaCodeExecutionToolResultErrorCode
ErrorCode BetaCodeExecutionToolResultErrorCode
Accepts one of the following:
const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"
const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"
const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"
const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"
Type CodeExecutionToolResultError
Type CodeExecutionToolResultError
Accepts one of the following:
const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"
type BetaCodeExecutionResultBlock struct{…}
type BetaCodeExecutionResultBlock struct{…}
Content []BetaCodeExecutionOutputBlock
Content []BetaCodeExecutionOutputBlock
FileID string
Type CodeExecutionOutput
Type CodeExecutionOutput
Accepts one of the following:
const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type CodeExecutionResult
Type CodeExecutionResult
Accepts one of the following:
const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"
type BetaCodeExecutionToolResultBlockParamResp struct{…}
type BetaCodeExecutionToolResultBlockParamResp struct{…}
Accepts one of the following:
type BetaCodeExecutionToolResultErrorParamResp struct{…}
type BetaCodeExecutionToolResultErrorParamResp struct{…}
ErrorCode BetaCodeExecutionToolResultErrorCode
ErrorCode BetaCodeExecutionToolResultErrorCode
Accepts one of the following:
const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"
const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"
const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"
const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"
Type CodeExecutionToolResultError
Type CodeExecutionToolResultError
Accepts one of the following:
const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"
type BetaCodeExecutionResultBlockParamResp struct{…}
type BetaCodeExecutionResultBlockParamResp struct{…}
Content []BetaCodeExecutionOutputBlockParamResp
Content []BetaCodeExecutionOutputBlockParamResp
FileID string
Type CodeExecutionOutput
Type CodeExecutionOutput
Accepts one of the following:
const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type CodeExecutionResult
Type CodeExecutionResult
Accepts one of the following:
const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"
ToolUseID string
Type CodeExecutionToolResult
Type CodeExecutionToolResult
Accepts one of the following:
const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaCodeExecutionToolResultBlockParamContentUnionResp interface{…}
type BetaCodeExecutionToolResultBlockParamContentUnionResp interface{…}
Accepts one of the following:
type BetaCodeExecutionToolResultErrorParamResp struct{…}
type BetaCodeExecutionToolResultErrorParamResp struct{…}
ErrorCode BetaCodeExecutionToolResultErrorCode
ErrorCode BetaCodeExecutionToolResultErrorCode
Accepts one of the following:
const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"
const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"
const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"
const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"
Type CodeExecutionToolResultError
Type CodeExecutionToolResultError
Accepts one of the following:
const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"
type BetaCodeExecutionResultBlockParamResp struct{…}
type BetaCodeExecutionResultBlockParamResp struct{…}
Content []BetaCodeExecutionOutputBlockParamResp
Content []BetaCodeExecutionOutputBlockParamResp
FileID string
Type CodeExecutionOutput
Type CodeExecutionOutput
Accepts one of the following:
const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type CodeExecutionResult
Type CodeExecutionResult
Accepts one of the following:
const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"
type BetaCodeExecutionToolResultError struct{…}
type BetaCodeExecutionToolResultError struct{…}
ErrorCode BetaCodeExecutionToolResultErrorCode
ErrorCode BetaCodeExecutionToolResultErrorCode
Accepts one of the following:
const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"
const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"
const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"
const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"
Type CodeExecutionToolResultError
Type CodeExecutionToolResultError
Accepts one of the following:
const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"
type BetaCodeExecutionToolResultErrorCode string
type BetaCodeExecutionToolResultErrorCode string
Accepts one of the following:
const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"
const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"
const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"
const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"
type BetaCodeExecutionToolResultErrorParamResp struct{…}
type BetaCodeExecutionToolResultErrorParamResp struct{…}
ErrorCode BetaCodeExecutionToolResultErrorCode
ErrorCode BetaCodeExecutionToolResultErrorCode
Accepts one of the following:
const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"
const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"
const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"
const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"
Type CodeExecutionToolResultError
Type CodeExecutionToolResultError
Accepts one of the following:
const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"
type BetaContainer struct{…}
type BetaContainer struct{…}
Information about the container used in the request (for the code execution tool)
ID string
ID string
Identifier for the container used in this request
ExpiresAt Time
ExpiresAt Time
The time at which the container will expire.
formatdate-time
Skills []BetaSkill
Skills []BetaSkill
Skills loaded in the container
SkillID string
SkillID string
Skill ID
maxLength64
minLength1
Type BetaSkillType
Type BetaSkillType
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Accepts one of the following:
const BetaSkillTypeAnthropic BetaSkillType = "anthropic"
const BetaSkillTypeCustom BetaSkillType = "custom"
Version string
Version string
Skill version or 'latest' for most recent version
maxLength64
minLength1
type BetaContainerParamsResp struct{…}
type BetaContainerParamsResp struct{…}
Container parameters with skills to be loaded.
ID stringoptional
ID stringoptional
Container id
List of skills to load in the container
SkillID string
SkillID string
Skill ID
maxLength64
minLength1
Type BetaSkillParamsType
Type BetaSkillParamsType
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Accepts one of the following:
const BetaSkillParamsTypeAnthropic BetaSkillParamsType = "anthropic"
const BetaSkillParamsTypeCustom BetaSkillParamsType = "custom"
Version stringoptional
Version stringoptional
Skill version or 'latest' for most recent version
maxLength64
minLength1
type BetaContainerUploadBlock struct{…}
type BetaContainerUploadBlock struct{…}
Response model for a file uploaded to the container.
FileID string
Type ContainerUpload
Type ContainerUpload
Accepts one of the following:
const ContainerUploadContainerUpload ContainerUpload = "container_upload"
type BetaContainerUploadBlockParamResp struct{…}
type BetaContainerUploadBlockParamResp struct{…}
A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory.
FileID string
Type ContainerUpload
Type ContainerUpload
Accepts one of the following:
const ContainerUploadContainerUpload ContainerUpload = "container_upload"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaContentBlockUnion interface{…}
type BetaContentBlockUnion interface{…}
Response model for a file uploaded to the container.
Accepts one of the following:
type BetaTextBlock struct{…}
type BetaTextBlock struct{…}
Citations []BetaTextCitationUnion
Citations []BetaTextCitationUnion
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
Accepts one of the following:
type BetaCitationCharLocation struct{…}
type BetaCitationCharLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
FileID string
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
type BetaThinkingBlock struct{…}
type BetaThinkingBlock struct{…}
Signature string
Thinking string
Type Thinking
Type Thinking
Accepts one of the following:
const ThinkingThinking Thinking = "thinking"
type BetaRedactedThinkingBlock struct{…}
type BetaRedactedThinkingBlock struct{…}
Data string
Type RedactedThinking
Type RedactedThinking
Accepts one of the following:
const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"
type BetaToolUseBlock struct{…}
type BetaToolUseBlock struct{…}
ID string
Input map[string, any]
Name string
Type ToolUse
Type ToolUse
Accepts one of the following:
const ToolUseToolUse ToolUse = "tool_use"
Caller BetaToolUseBlockCallerUnionoptional
Caller BetaToolUseBlockCallerUnionoptional
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
Type Direct
Accepts one of the following:
const DirectDirect Direct = "direct"
type BetaServerToolCaller struct{…}
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
type BetaServerToolUseBlock struct{…}
type BetaServerToolUseBlock struct{…}
ID string
Caller BetaServerToolUseBlockCallerUnion
Caller BetaServerToolUseBlockCallerUnion
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
Type Direct
Accepts one of the following:
const DirectDirect Direct = "direct"
type BetaServerToolCaller struct{…}
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
Input map[string, any]
Name BetaServerToolUseBlockName
Name BetaServerToolUseBlockName
Accepts one of the following:
const BetaServerToolUseBlockNameWebSearch BetaServerToolUseBlockName = "web_search"
const BetaServerToolUseBlockNameWebFetch BetaServerToolUseBlockName = "web_fetch"
const BetaServerToolUseBlockNameCodeExecution BetaServerToolUseBlockName = "code_execution"
const BetaServerToolUseBlockNameBashCodeExecution BetaServerToolUseBlockName = "bash_code_execution"
const BetaServerToolUseBlockNameTextEditorCodeExecution BetaServerToolUseBlockName = "text_editor_code_execution"
const BetaServerToolUseBlockNameToolSearchToolRegex BetaServerToolUseBlockName = "tool_search_tool_regex"
const BetaServerToolUseBlockNameToolSearchToolBm25 BetaServerToolUseBlockName = "tool_search_tool_bm25"
Type ServerToolUse
Type ServerToolUse
Accepts one of the following:
const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"
type BetaWebSearchToolResultBlock struct{…}
type BetaWebSearchToolResultBlock struct{…}
Accepts one of the following:
type BetaWebSearchToolResultError struct{…}
type BetaWebSearchToolResultError struct{…}
ErrorCode BetaWebSearchToolResultErrorCode
ErrorCode BetaWebSearchToolResultErrorCode
Accepts one of the following:
const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"
const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"
const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"
const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"
Type WebSearchToolResultError
Type WebSearchToolResultError
Accepts one of the following:
const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"
EncryptedContent string
PageAge string
Title string
Type WebSearchResult
Type WebSearchResult
Accepts one of the following:
const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"
URL string
ToolUseID string
Type WebSearchToolResult
Type WebSearchToolResult
Accepts one of the following:
const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"
type BetaWebFetchToolResultBlock struct{…}
type BetaWebFetchToolResultBlock struct{…}
Content BetaWebFetchToolResultBlockContentUnion
Content BetaWebFetchToolResultBlockContentUnion
Accepts one of the following:
type BetaWebFetchToolResultErrorBlock struct{…}
type BetaWebFetchToolResultErrorBlock struct{…}
ErrorCode BetaWebFetchToolResultErrorCode
ErrorCode BetaWebFetchToolResultErrorCode
Accepts one of the following:
const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"
const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"
const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"
const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"
const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"
const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"
Type WebFetchToolResultError
Type WebFetchToolResultError
Accepts one of the following:
const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"
type BetaWebFetchBlock struct{…}
type BetaWebFetchBlock struct{…}
Content BetaDocumentBlock
Content BetaDocumentBlock
Citations BetaCitationConfig
Citations BetaCitationConfig
Citation configuration for the document
Enabled bool
Source BetaDocumentBlockSourceUnion
Source BetaDocumentBlockSourceUnion
Accepts one of the following:
type BetaBase64PDFSource struct{…}
type BetaBase64PDFSource struct{…}
Data string
MediaType ApplicationPDF
MediaType ApplicationPDF
Accepts one of the following:
const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaPlainTextSource struct{…}
type BetaPlainTextSource struct{…}
Data string
MediaType TextPlain
MediaType TextPlain
Accepts one of the following:
const TextPlainTextPlain TextPlain = "text/plain"
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Title string
Title string
The title of the document
Type Document
Type Document
Accepts one of the following:
const DocumentDocument Document = "document"
RetrievedAt string
RetrievedAt string
ISO 8601 timestamp when the content was retrieved
Type WebFetchResult
Type WebFetchResult
Accepts one of the following:
const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"
URL string
URL string
Fetched content URL
ToolUseID string
Type WebFetchToolResult
Type WebFetchToolResult
Accepts one of the following:
const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"
type BetaCodeExecutionToolResultBlock struct{…}
type BetaCodeExecutionToolResultBlock struct{…}
Accepts one of the following:
type BetaCodeExecutionToolResultError struct{…}
type BetaCodeExecutionToolResultError struct{…}
ErrorCode BetaCodeExecutionToolResultErrorCode
ErrorCode BetaCodeExecutionToolResultErrorCode
Accepts one of the following:
const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"
const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"
const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"
const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"
Type CodeExecutionToolResultError
Type CodeExecutionToolResultError
Accepts one of the following:
const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"
type BetaCodeExecutionResultBlock struct{…}
type BetaCodeExecutionResultBlock struct{…}
Content []BetaCodeExecutionOutputBlock
Content []BetaCodeExecutionOutputBlock
FileID string
Type CodeExecutionOutput
Type CodeExecutionOutput
Accepts one of the following:
const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type CodeExecutionResult
Type CodeExecutionResult
Accepts one of the following:
const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"
ToolUseID string
Type CodeExecutionToolResult
Type CodeExecutionToolResult
Accepts one of the following:
const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"
type BetaBashCodeExecutionToolResultBlock struct{…}
type BetaBashCodeExecutionToolResultBlock struct{…}
Content BetaBashCodeExecutionToolResultBlockContentUnion
Content BetaBashCodeExecutionToolResultBlockContentUnion
Accepts one of the following:
type BetaBashCodeExecutionToolResultError struct{…}
type BetaBashCodeExecutionToolResultError struct{…}
ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode
ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode
Accepts one of the following:
const BetaBashCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"
const BetaBashCodeExecutionToolResultErrorErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorErrorCode = "unavailable"
const BetaBashCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorErrorCode = "too_many_requests"
const BetaBashCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"
const BetaBashCodeExecutionToolResultErrorErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorErrorCode = "output_file_too_large"
Type BashCodeExecutionToolResultError
Type BashCodeExecutionToolResultError
Accepts one of the following:
const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"
type BetaBashCodeExecutionResultBlock struct{…}
type BetaBashCodeExecutionResultBlock struct{…}
Content []BetaBashCodeExecutionOutputBlock
Content []BetaBashCodeExecutionOutputBlock
FileID string
Type BashCodeExecutionOutput
Type BashCodeExecutionOutput
Accepts one of the following:
const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type BashCodeExecutionResult
Type BashCodeExecutionResult
Accepts one of the following:
const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"
ToolUseID string
Type BashCodeExecutionToolResult
Type BashCodeExecutionToolResult
Accepts one of the following:
const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"
type BetaTextEditorCodeExecutionToolResultBlock struct{…}
type BetaTextEditorCodeExecutionToolResultBlock struct{…}
Content BetaTextEditorCodeExecutionToolResultBlockContentUnion
Content BetaTextEditorCodeExecutionToolResultBlockContentUnion
Accepts one of the following:
type BetaTextEditorCodeExecutionToolResultError struct{…}
type BetaTextEditorCodeExecutionToolResultError struct{…}
ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode
ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode
Accepts one of the following:
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorErrorCode = "unavailable"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorErrorCode = "too_many_requests"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorErrorCode = "file_not_found"
ErrorMessage string
Type TextEditorCodeExecutionToolResultError
Type TextEditorCodeExecutionToolResultError
Accepts one of the following:
const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"
type BetaTextEditorCodeExecutionViewResultBlock struct{…}
type BetaTextEditorCodeExecutionViewResultBlock struct{…}
Content string
FileType BetaTextEditorCodeExecutionViewResultBlockFileType
FileType BetaTextEditorCodeExecutionViewResultBlockFileType
Accepts one of the following:
const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"
const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"
const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"
NumLines int64
StartLine int64
TotalLines int64
Type TextEditorCodeExecutionViewResult
Type TextEditorCodeExecutionViewResult
Accepts one of the following:
const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"
type BetaTextEditorCodeExecutionCreateResultBlock struct{…}
type BetaTextEditorCodeExecutionCreateResultBlock struct{…}
IsFileUpdate bool
Type TextEditorCodeExecutionCreateResult
Type TextEditorCodeExecutionCreateResult
Accepts one of the following:
const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"
type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}
type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}
Lines []string
NewLines int64
NewStart int64
OldLines int64
OldStart int64
Type TextEditorCodeExecutionStrReplaceResult
Type TextEditorCodeExecutionStrReplaceResult
Accepts one of the following:
const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"
ToolUseID string
Type TextEditorCodeExecutionToolResult
Type TextEditorCodeExecutionToolResult
Accepts one of the following:
const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"
type BetaToolSearchToolResultBlock struct{…}
type BetaToolSearchToolResultBlock struct{…}
Content BetaToolSearchToolResultBlockContentUnion
Content BetaToolSearchToolResultBlockContentUnion
Accepts one of the following:
type BetaToolSearchToolResultError struct{…}
type BetaToolSearchToolResultError struct{…}
ErrorCode BetaToolSearchToolResultErrorErrorCode
ErrorCode BetaToolSearchToolResultErrorErrorCode
Accepts one of the following:
const BetaToolSearchToolResultErrorErrorCodeInvalidToolInput BetaToolSearchToolResultErrorErrorCode = "invalid_tool_input"
const BetaToolSearchToolResultErrorErrorCodeUnavailable BetaToolSearchToolResultErrorErrorCode = "unavailable"
const BetaToolSearchToolResultErrorErrorCodeTooManyRequests BetaToolSearchToolResultErrorErrorCode = "too_many_requests"
const BetaToolSearchToolResultErrorErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorErrorCode = "execution_time_exceeded"
ErrorMessage string
Type ToolSearchToolResultError
Type ToolSearchToolResultError
Accepts one of the following:
const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"
type BetaToolSearchToolSearchResultBlock struct{…}
type BetaToolSearchToolSearchResultBlock struct{…}
ToolReferences []BetaToolReferenceBlock
ToolReferences []BetaToolReferenceBlock
ToolName string
Type ToolReference
Type ToolReference
Accepts one of the following:
const ToolReferenceToolReference ToolReference = "tool_reference"
Type ToolSearchToolSearchResult
Type ToolSearchToolSearchResult
Accepts one of the following:
const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"
ToolUseID string
Type ToolSearchToolResult
Type ToolSearchToolResult
Accepts one of the following:
const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"
type BetaMCPToolUseBlock struct{…}
type BetaMCPToolUseBlock struct{…}
ID string
Input map[string, any]
Name string
Name string
The name of the MCP tool
ServerName string
ServerName string
The name of the MCP server
Type MCPToolUse
Type MCPToolUse
Accepts one of the following:
const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"
type BetaMCPToolResultBlock struct{…}
type BetaMCPToolResultBlock struct{…}
Content BetaMCPToolResultBlockContentUnion
Content BetaMCPToolResultBlockContentUnion
Accepts one of the following:
string
Citations []BetaTextCitationUnion
Citations []BetaTextCitationUnion
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
Accepts one of the following:
type BetaCitationCharLocation struct{…}
type BetaCitationCharLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
FileID string
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
IsError bool
ToolUseID string
Type MCPToolResult
Type MCPToolResult
Accepts one of the following:
const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"
type BetaContainerUploadBlock struct{…}
type BetaContainerUploadBlock struct{…}
Response model for a file uploaded to the container.
FileID string
Type ContainerUpload
Type ContainerUpload
Accepts one of the following:
const ContainerUploadContainerUpload ContainerUpload = "container_upload"
type BetaContentBlockParamUnionResp interface{…}
type BetaContentBlockParamUnionResp interface{…}
Regular text content.
Accepts one of the following:
type BetaTextBlockParamResp struct{…}
type BetaTextBlockParamResp struct{…}
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
type BetaImageBlockParamResp struct{…}
type BetaImageBlockParamResp struct{…}
Source BetaImageBlockParamSourceUnionResp
Source BetaImageBlockParamSourceUnionResp
Accepts one of the following:
type BetaBase64ImageSource struct{…}
type BetaBase64ImageSource struct{…}
Data string
MediaType BetaBase64ImageSourceMediaType
MediaType BetaBase64ImageSourceMediaType
Accepts one of the following:
const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"
const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"
const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"
const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaURLImageSource struct{…}
type BetaURLImageSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileImageSource struct{…}
type BetaFileImageSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Image
Type Image
Accepts one of the following:
const ImageImage Image = "image"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaRequestDocumentBlock struct{…}
type BetaRequestDocumentBlock struct{…}
Source BetaRequestDocumentBlockSourceUnion
Source BetaRequestDocumentBlockSourceUnion
Accepts one of the following:
type BetaBase64PDFSource struct{…}
type BetaBase64PDFSource struct{…}
Data string
MediaType ApplicationPDF
MediaType ApplicationPDF
Accepts one of the following:
const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaPlainTextSource struct{…}
type BetaPlainTextSource struct{…}
Data string
MediaType TextPlain
MediaType TextPlain
Accepts one of the following:
const TextPlainTextPlain TextPlain = "text/plain"
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
type BetaContentBlockSource struct{…}
type BetaContentBlockSource struct{…}
Content BetaContentBlockSourceContentUnion
Content BetaContentBlockSourceContentUnion
Accepts one of the following:
string
Accepts one of the following:
type BetaTextBlockParamResp struct{…}
type BetaTextBlockParamResp struct{…}
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
type BetaImageBlockParamResp struct{…}
type BetaImageBlockParamResp struct{…}
Source BetaImageBlockParamSourceUnionResp
Source BetaImageBlockParamSourceUnionResp
Accepts one of the following:
type BetaBase64ImageSource struct{…}
type BetaBase64ImageSource struct{…}
Data string
MediaType BetaBase64ImageSourceMediaType
MediaType BetaBase64ImageSourceMediaType
Accepts one of the following:
const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"
const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"
const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"
const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaURLImageSource struct{…}
type BetaURLImageSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileImageSource struct{…}
type BetaFileImageSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Image
Type Image
Accepts one of the following:
const ImageImage Image = "image"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Type Content
Type Content
Accepts one of the following:
const ContentContent Content = "content"
type BetaURLPDFSource struct{…}
type BetaURLPDFSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileDocumentSource struct{…}
type BetaFileDocumentSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Document
Type Document
Accepts one of the following:
const DocumentDocument Document = "document"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Enabled booloptional
Context stringoptional
Title stringoptional
type BetaSearchResultBlockParamResp struct{…}
type BetaSearchResultBlockParamResp struct{…}
Content []BetaTextBlockParamResp
Content []BetaTextBlockParamResp
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Source string
Title string
Type SearchResult
Type SearchResult
Accepts one of the following:
const SearchResultSearchResult SearchResult = "search_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Enabled booloptional
type BetaThinkingBlockParamResp struct{…}
type BetaThinkingBlockParamResp struct{…}
Signature string
Thinking string
Type Thinking
Type Thinking
Accepts one of the following:
const ThinkingThinking Thinking = "thinking"
type BetaRedactedThinkingBlockParamResp struct{…}
type BetaRedactedThinkingBlockParamResp struct{…}
Data string
Type RedactedThinking
Type RedactedThinking
Accepts one of the following:
const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"
type BetaToolUseBlockParamResp struct{…}
type BetaToolUseBlockParamResp struct{…}
ID string
Input map[string, any]
Name string
Type ToolUse
Type ToolUse
Accepts one of the following:
const ToolUseToolUse ToolUse = "tool_use"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Caller BetaToolUseBlockParamCallerUnionRespoptional
Caller BetaToolUseBlockParamCallerUnionRespoptional
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
Type Direct
Accepts one of the following:
const DirectDirect Direct = "direct"
type BetaServerToolCaller struct{…}
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
type BetaToolResultBlockParamResp struct{…}
type BetaToolResultBlockParamResp struct{…}
ToolUseID string
Type ToolResult
Type ToolResult
Accepts one of the following:
const ToolResultToolResult ToolResult = "tool_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Content []BetaToolResultBlockParamContentUnionRespoptional
Content []BetaToolResultBlockParamContentUnionRespoptional
Accepts one of the following:
[]BetaToolResultBlockParamContentUnionResp
[]BetaToolResultBlockParamContentUnionResp
Accepts one of the following:
type BetaTextBlockParamResp struct{…}
type BetaTextBlockParamResp struct{…}
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
type BetaImageBlockParamResp struct{…}
type BetaImageBlockParamResp struct{…}
Source BetaImageBlockParamSourceUnionResp
Source BetaImageBlockParamSourceUnionResp
Accepts one of the following:
type BetaBase64ImageSource struct{…}
type BetaBase64ImageSource struct{…}
Data string
MediaType BetaBase64ImageSourceMediaType
MediaType BetaBase64ImageSourceMediaType
Accepts one of the following:
const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"
const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"
const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"
const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaURLImageSource struct{…}
type BetaURLImageSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileImageSource struct{…}
type BetaFileImageSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Image
Type Image
Accepts one of the following:
const ImageImage Image = "image"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaSearchResultBlockParamResp struct{…}
type BetaSearchResultBlockParamResp struct{…}
Content []BetaTextBlockParamResp
Content []BetaTextBlockParamResp
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Source string
Title string
Type SearchResult
Type SearchResult
Accepts one of the following:
const SearchResultSearchResult SearchResult = "search_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Enabled booloptional
type BetaRequestDocumentBlock struct{…}
type BetaRequestDocumentBlock struct{…}
Source BetaRequestDocumentBlockSourceUnion
Source BetaRequestDocumentBlockSourceUnion
Accepts one of the following:
type BetaBase64PDFSource struct{…}
type BetaBase64PDFSource struct{…}
Data string
MediaType ApplicationPDF
MediaType ApplicationPDF
Accepts one of the following:
const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaPlainTextSource struct{…}
type BetaPlainTextSource struct{…}
Data string
MediaType TextPlain
MediaType TextPlain
Accepts one of the following:
const TextPlainTextPlain TextPlain = "text/plain"
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
type BetaContentBlockSource struct{…}
type BetaContentBlockSource struct{…}
Content BetaContentBlockSourceContentUnion
Content BetaContentBlockSourceContentUnion
Accepts one of the following:
string
Accepts one of the following:
type BetaTextBlockParamResp struct{…}
type BetaTextBlockParamResp struct{…}
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
type BetaImageBlockParamResp struct{…}
type BetaImageBlockParamResp struct{…}
Source BetaImageBlockParamSourceUnionResp
Source BetaImageBlockParamSourceUnionResp
Accepts one of the following:
type BetaBase64ImageSource struct{…}
type BetaBase64ImageSource struct{…}
Data string
MediaType BetaBase64ImageSourceMediaType
MediaType BetaBase64ImageSourceMediaType
Accepts one of the following:
const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"
const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"
const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"
const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaURLImageSource struct{…}
type BetaURLImageSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileImageSource struct{…}
type BetaFileImageSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Image
Type Image
Accepts one of the following:
const ImageImage Image = "image"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Type Content
Type Content
Accepts one of the following:
const ContentContent Content = "content"
type BetaURLPDFSource struct{…}
type BetaURLPDFSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileDocumentSource struct{…}
type BetaFileDocumentSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Document
Type Document
Accepts one of the following:
const DocumentDocument Document = "document"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Enabled booloptional
Context stringoptional
Title stringoptional
type BetaToolReferenceBlockParamResp struct{…}
type BetaToolReferenceBlockParamResp struct{…}
Tool reference block that can be included in tool_result content.
ToolName string
Type ToolReference
Type ToolReference
Accepts one of the following:
const ToolReferenceToolReference ToolReference = "tool_reference"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
IsError booloptional
type BetaServerToolUseBlockParamResp struct{…}
type BetaServerToolUseBlockParamResp struct{…}
ID string
Input map[string, any]
Name BetaServerToolUseBlockParamName
Name BetaServerToolUseBlockParamName
Accepts one of the following:
const BetaServerToolUseBlockParamNameWebSearch BetaServerToolUseBlockParamName = "web_search"
const BetaServerToolUseBlockParamNameWebFetch BetaServerToolUseBlockParamName = "web_fetch"
const BetaServerToolUseBlockParamNameCodeExecution BetaServerToolUseBlockParamName = "code_execution"
const BetaServerToolUseBlockParamNameBashCodeExecution BetaServerToolUseBlockParamName = "bash_code_execution"
const BetaServerToolUseBlockParamNameTextEditorCodeExecution BetaServerToolUseBlockParamName = "text_editor_code_execution"
const BetaServerToolUseBlockParamNameToolSearchToolRegex BetaServerToolUseBlockParamName = "tool_search_tool_regex"
const BetaServerToolUseBlockParamNameToolSearchToolBm25 BetaServerToolUseBlockParamName = "tool_search_tool_bm25"
Type ServerToolUse
Type ServerToolUse
Accepts one of the following:
const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Caller BetaServerToolUseBlockParamCallerUnionRespoptional
Caller BetaServerToolUseBlockParamCallerUnionRespoptional
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
Type Direct
Accepts one of the following:
const DirectDirect Direct = "direct"
type BetaServerToolCaller struct{…}
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
type BetaWebSearchToolResultBlockParamResp struct{…}
type BetaWebSearchToolResultBlockParamResp struct{…}
Accepts one of the following:
EncryptedContent string
Title string
Type WebSearchResult
Type WebSearchResult
Accepts one of the following:
const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"
URL string
PageAge stringoptional
type BetaWebSearchToolRequestError struct{…}
type BetaWebSearchToolRequestError struct{…}
ErrorCode BetaWebSearchToolResultErrorCode
ErrorCode BetaWebSearchToolResultErrorCode
Accepts one of the following:
const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"
const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"
const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"
const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"
Type WebSearchToolResultError
Type WebSearchToolResultError
Accepts one of the following:
const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"
ToolUseID string
Type WebSearchToolResult
Type WebSearchToolResult
Accepts one of the following:
const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaWebFetchToolResultBlockParamResp struct{…}
type BetaWebFetchToolResultBlockParamResp struct{…}
Content BetaWebFetchToolResultBlockParamContentUnionResp
Content BetaWebFetchToolResultBlockParamContentUnionResp
Accepts one of the following:
type BetaWebFetchToolResultErrorBlockParamResp struct{…}
type BetaWebFetchToolResultErrorBlockParamResp struct{…}
ErrorCode BetaWebFetchToolResultErrorCode
ErrorCode BetaWebFetchToolResultErrorCode
Accepts one of the following:
const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"
const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"
const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"
const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"
const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"
const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"
Type WebFetchToolResultError
Type WebFetchToolResultError
Accepts one of the following:
const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"
type BetaWebFetchBlockParamResp struct{…}
type BetaWebFetchBlockParamResp struct{…}
Content BetaRequestDocumentBlock
Content BetaRequestDocumentBlock
Source BetaRequestDocumentBlockSourceUnion
Source BetaRequestDocumentBlockSourceUnion
Accepts one of the following:
type BetaBase64PDFSource struct{…}
type BetaBase64PDFSource struct{…}
Data string
MediaType ApplicationPDF
MediaType ApplicationPDF
Accepts one of the following:
const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaPlainTextSource struct{…}
type BetaPlainTextSource struct{…}
Data string
MediaType TextPlain
MediaType TextPlain
Accepts one of the following:
const TextPlainTextPlain TextPlain = "text/plain"
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
type BetaContentBlockSource struct{…}
type BetaContentBlockSource struct{…}
Content BetaContentBlockSourceContentUnion
Content BetaContentBlockSourceContentUnion
Accepts one of the following:
string
Accepts one of the following:
type BetaTextBlockParamResp struct{…}
type BetaTextBlockParamResp struct{…}
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
type BetaImageBlockParamResp struct{…}
type BetaImageBlockParamResp struct{…}
Source BetaImageBlockParamSourceUnionResp
Source BetaImageBlockParamSourceUnionResp
Accepts one of the following:
type BetaBase64ImageSource struct{…}
type BetaBase64ImageSource struct{…}
Data string
MediaType BetaBase64ImageSourceMediaType
MediaType BetaBase64ImageSourceMediaType
Accepts one of the following:
const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"
const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"
const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"
const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaURLImageSource struct{…}
type BetaURLImageSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileImageSource struct{…}
type BetaFileImageSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Image
Type Image
Accepts one of the following:
const ImageImage Image = "image"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Type Content
Type Content
Accepts one of the following:
const ContentContent Content = "content"
type BetaURLPDFSource struct{…}
type BetaURLPDFSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileDocumentSource struct{…}
type BetaFileDocumentSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Document
Type Document
Accepts one of the following:
const DocumentDocument Document = "document"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Enabled booloptional
Context stringoptional
Title stringoptional
Type WebFetchResult
Type WebFetchResult
Accepts one of the following:
const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"
URL string
URL string
Fetched content URL
RetrievedAt stringoptional
RetrievedAt stringoptional
ISO 8601 timestamp when the content was retrieved
ToolUseID string
Type WebFetchToolResult
Type WebFetchToolResult
Accepts one of the following:
const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaCodeExecutionToolResultBlockParamResp struct{…}
type BetaCodeExecutionToolResultBlockParamResp struct{…}
Accepts one of the following:
type BetaCodeExecutionToolResultErrorParamResp struct{…}
type BetaCodeExecutionToolResultErrorParamResp struct{…}
ErrorCode BetaCodeExecutionToolResultErrorCode
ErrorCode BetaCodeExecutionToolResultErrorCode
Accepts one of the following:
const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"
const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"
const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"
const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"
Type CodeExecutionToolResultError
Type CodeExecutionToolResultError
Accepts one of the following:
const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"
type BetaCodeExecutionResultBlockParamResp struct{…}
type BetaCodeExecutionResultBlockParamResp struct{…}
Content []BetaCodeExecutionOutputBlockParamResp
Content []BetaCodeExecutionOutputBlockParamResp
FileID string
Type CodeExecutionOutput
Type CodeExecutionOutput
Accepts one of the following:
const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type CodeExecutionResult
Type CodeExecutionResult
Accepts one of the following:
const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"
ToolUseID string
Type CodeExecutionToolResult
Type CodeExecutionToolResult
Accepts one of the following:
const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaBashCodeExecutionToolResultBlockParamResp struct{…}
type BetaBashCodeExecutionToolResultBlockParamResp struct{…}
Content BetaBashCodeExecutionToolResultBlockParamContentUnionResp
Content BetaBashCodeExecutionToolResultBlockParamContentUnionResp
Accepts one of the following:
type BetaBashCodeExecutionToolResultErrorParamResp struct{…}
type BetaBashCodeExecutionToolResultErrorParamResp struct{…}
ErrorCode BetaBashCodeExecutionToolResultErrorParamErrorCode
ErrorCode BetaBashCodeExecutionToolResultErrorParamErrorCode
Accepts one of the following:
const BetaBashCodeExecutionToolResultErrorParamErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorParamErrorCode = "invalid_tool_input"
const BetaBashCodeExecutionToolResultErrorParamErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorParamErrorCode = "unavailable"
const BetaBashCodeExecutionToolResultErrorParamErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorParamErrorCode = "too_many_requests"
const BetaBashCodeExecutionToolResultErrorParamErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorParamErrorCode = "execution_time_exceeded"
const BetaBashCodeExecutionToolResultErrorParamErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorParamErrorCode = "output_file_too_large"
Type BashCodeExecutionToolResultError
Type BashCodeExecutionToolResultError
Accepts one of the following:
const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"
type BetaBashCodeExecutionResultBlockParamResp struct{…}
type BetaBashCodeExecutionResultBlockParamResp struct{…}
FileID string
Type BashCodeExecutionOutput
Type BashCodeExecutionOutput
Accepts one of the following:
const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type BashCodeExecutionResult
Type BashCodeExecutionResult
Accepts one of the following:
const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"
ToolUseID string
Type BashCodeExecutionToolResult
Type BashCodeExecutionToolResult
Accepts one of the following:
const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaTextEditorCodeExecutionToolResultBlockParamResp struct{…}
type BetaTextEditorCodeExecutionToolResultBlockParamResp struct{…}
Content BetaTextEditorCodeExecutionToolResultBlockParamContentUnionResp
Content BetaTextEditorCodeExecutionToolResultBlockParamContentUnionResp
Accepts one of the following:
type BetaTextEditorCodeExecutionToolResultErrorParamResp struct{…}
type BetaTextEditorCodeExecutionToolResultErrorParamResp struct{…}
ErrorCode BetaTextEditorCodeExecutionToolResultErrorParamErrorCode
ErrorCode BetaTextEditorCodeExecutionToolResultErrorParamErrorCode
Accepts one of the following:
const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "invalid_tool_input"
const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "unavailable"
const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "too_many_requests"
const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "execution_time_exceeded"
const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "file_not_found"
Type TextEditorCodeExecutionToolResultError
Type TextEditorCodeExecutionToolResultError
Accepts one of the following:
const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"
ErrorMessage stringoptional
type BetaTextEditorCodeExecutionViewResultBlockParamResp struct{…}
type BetaTextEditorCodeExecutionViewResultBlockParamResp struct{…}
Content string
FileType BetaTextEditorCodeExecutionViewResultBlockParamFileType
FileType BetaTextEditorCodeExecutionViewResultBlockParamFileType
Accepts one of the following:
const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeText BetaTextEditorCodeExecutionViewResultBlockParamFileType = "text"
const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeImage BetaTextEditorCodeExecutionViewResultBlockParamFileType = "image"
const BetaTextEditorCodeExecutionViewResultBlockParamFileTypePDF BetaTextEditorCodeExecutionViewResultBlockParamFileType = "pdf"
Type TextEditorCodeExecutionViewResult
Type TextEditorCodeExecutionViewResult
Accepts one of the following:
const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"
NumLines int64optional
StartLine int64optional
TotalLines int64optional
type BetaTextEditorCodeExecutionCreateResultBlockParamResp struct{…}
type BetaTextEditorCodeExecutionCreateResultBlockParamResp struct{…}
IsFileUpdate bool
Type TextEditorCodeExecutionCreateResult
Type TextEditorCodeExecutionCreateResult
Accepts one of the following:
const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"
type BetaTextEditorCodeExecutionStrReplaceResultBlockParamResp struct{…}
type BetaTextEditorCodeExecutionStrReplaceResultBlockParamResp struct{…}
Type TextEditorCodeExecutionStrReplaceResult
Type TextEditorCodeExecutionStrReplaceResult
Accepts one of the following:
const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"
Lines []stringoptional
NewLines int64optional
NewStart int64optional
OldLines int64optional
OldStart int64optional
ToolUseID string
Type TextEditorCodeExecutionToolResult
Type TextEditorCodeExecutionToolResult
Accepts one of the following:
const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaToolSearchToolResultBlockParamResp struct{…}
type BetaToolSearchToolResultBlockParamResp struct{…}
Content BetaToolSearchToolResultBlockParamContentUnionResp
Content BetaToolSearchToolResultBlockParamContentUnionResp
Accepts one of the following:
type BetaToolSearchToolResultErrorParamResp struct{…}
type BetaToolSearchToolResultErrorParamResp struct{…}
ErrorCode BetaToolSearchToolResultErrorParamErrorCode
ErrorCode BetaToolSearchToolResultErrorParamErrorCode
Accepts one of the following:
const BetaToolSearchToolResultErrorParamErrorCodeInvalidToolInput BetaToolSearchToolResultErrorParamErrorCode = "invalid_tool_input"
const BetaToolSearchToolResultErrorParamErrorCodeUnavailable BetaToolSearchToolResultErrorParamErrorCode = "unavailable"
const BetaToolSearchToolResultErrorParamErrorCodeTooManyRequests BetaToolSearchToolResultErrorParamErrorCode = "too_many_requests"
const BetaToolSearchToolResultErrorParamErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorParamErrorCode = "execution_time_exceeded"
Type ToolSearchToolResultError
Type ToolSearchToolResultError
Accepts one of the following:
const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"
type BetaToolSearchToolSearchResultBlockParamResp struct{…}
type BetaToolSearchToolSearchResultBlockParamResp struct{…}
ToolReferences []BetaToolReferenceBlockParamResp
ToolReferences []BetaToolReferenceBlockParamResp
ToolName string
Type ToolReference
Type ToolReference
Accepts one of the following:
const ToolReferenceToolReference ToolReference = "tool_reference"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Type ToolSearchToolSearchResult
Type ToolSearchToolSearchResult
Accepts one of the following:
const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"
ToolUseID string
Type ToolSearchToolResult
Type ToolSearchToolResult
Accepts one of the following:
const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaMCPToolUseBlockParamResp struct{…}
type BetaMCPToolUseBlockParamResp struct{…}
ID string
Input map[string, any]
Name string
ServerName string
ServerName string
The name of the MCP server
Type MCPToolUse
Type MCPToolUse
Accepts one of the following:
const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaRequestMCPToolResultBlockParamResp struct{…}
type BetaRequestMCPToolResultBlockParamResp struct{…}
ToolUseID string
Type MCPToolResult
Type MCPToolResult
Accepts one of the following:
const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Content BetaRequestMCPToolResultBlockParamContentUnionRespoptional
Content BetaRequestMCPToolResultBlockParamContentUnionRespoptional
Accepts one of the following:
string
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
IsError booloptional
type BetaContainerUploadBlockParamResp struct{…}
type BetaContainerUploadBlockParamResp struct{…}
A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory.
FileID string
Type ContainerUpload
Type ContainerUpload
Accepts one of the following:
const ContainerUploadContainerUpload ContainerUpload = "container_upload"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaContentBlockSource struct{…}
type BetaContentBlockSource struct{…}
Content BetaContentBlockSourceContentUnion
Content BetaContentBlockSourceContentUnion
Accepts one of the following:
string
Accepts one of the following:
type BetaTextBlockParamResp struct{…}
type BetaTextBlockParamResp struct{…}
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
type BetaImageBlockParamResp struct{…}
type BetaImageBlockParamResp struct{…}
Source BetaImageBlockParamSourceUnionResp
Source BetaImageBlockParamSourceUnionResp
Accepts one of the following:
type BetaBase64ImageSource struct{…}
type BetaBase64ImageSource struct{…}
Data string
MediaType BetaBase64ImageSourceMediaType
MediaType BetaBase64ImageSourceMediaType
Accepts one of the following:
const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"
const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"
const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"
const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaURLImageSource struct{…}
type BetaURLImageSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileImageSource struct{…}
type BetaFileImageSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Image
Type Image
Accepts one of the following:
const ImageImage Image = "image"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Type Content
Type Content
Accepts one of the following:
const ContentContent Content = "content"
type BetaContentBlockSourceContentUnion interface{…}
type BetaContentBlockSourceContentUnion interface{…}
Accepts one of the following:
type BetaTextBlockParamResp struct{…}
type BetaTextBlockParamResp struct{…}
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
type BetaImageBlockParamResp struct{…}
type BetaImageBlockParamResp struct{…}
Source BetaImageBlockParamSourceUnionResp
Source BetaImageBlockParamSourceUnionResp
Accepts one of the following:
type BetaBase64ImageSource struct{…}
type BetaBase64ImageSource struct{…}
Data string
MediaType BetaBase64ImageSourceMediaType
MediaType BetaBase64ImageSourceMediaType
Accepts one of the following:
const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"
const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"
const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"
const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaURLImageSource struct{…}
type BetaURLImageSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileImageSource struct{…}
type BetaFileImageSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Image
Type Image
Accepts one of the following:
const ImageImage Image = "image"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaContextManagementConfig struct{…}
type BetaContextManagementConfig struct{…}
Edits []BetaContextManagementConfigEditUnionoptional
Edits []BetaContextManagementConfigEditUnionoptional
List of context management edits to apply
Accepts one of the following:
type BetaClearToolUses20250919Edit struct{…}
type BetaClearToolUses20250919Edit struct{…}
Type ClearToolUses20250919
Type ClearToolUses20250919
Accepts one of the following:
const ClearToolUses20250919ClearToolUses20250919 ClearToolUses20250919 = "clear_tool_uses_20250919"
Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed.
Type InputTokens
Type InputTokens
Accepts one of the following:
const InputTokensInputTokens InputTokens = "input_tokens"
Value int64
ClearToolInputs BetaClearToolUses20250919EditClearToolInputsUnionoptional
ClearToolInputs BetaClearToolUses20250919EditClearToolInputsUnionoptional
Whether to clear all tool inputs (bool) or specific tool inputs to clear (list)
Accepts one of the following:
bool
[]string
ExcludeTools []stringoptional
ExcludeTools []stringoptional
Tool names whose uses are preserved from clearing
Number of tool uses to retain in the conversation
Type ToolUses
Type ToolUses
Accepts one of the following:
const ToolUsesToolUses ToolUses = "tool_uses"
Value int64
Trigger BetaClearToolUses20250919EditTriggerUnionoptional
Trigger BetaClearToolUses20250919EditTriggerUnionoptional
Condition that triggers the context management strategy
Accepts one of the following:
type BetaInputTokensTrigger struct{…}
type BetaInputTokensTrigger struct{…}
Type InputTokens
Type InputTokens
Accepts one of the following:
const InputTokensInputTokens InputTokens = "input_tokens"
Value int64
type BetaToolUsesTrigger struct{…}
type BetaToolUsesTrigger struct{…}
Type ToolUses
Type ToolUses
Accepts one of the following:
const ToolUsesToolUses ToolUses = "tool_uses"
Value int64
type BetaClearThinking20251015Edit struct{…}
type BetaClearThinking20251015Edit struct{…}
Type ClearThinking20251015
Type ClearThinking20251015
Accepts one of the following:
const ClearThinking20251015ClearThinking20251015 ClearThinking20251015 = "clear_thinking_20251015"
Keep BetaClearThinking20251015EditKeepUnionoptional
Keep BetaClearThinking20251015EditKeepUnionoptional
Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed.
Accepts one of the following:
type BetaThinkingTurns struct{…}
type BetaThinkingTurns struct{…}
Type ThinkingTurns
Type ThinkingTurns
Accepts one of the following:
const ThinkingTurnsThinkingTurns ThinkingTurns = "thinking_turns"
Value int64
type BetaAllThinkingTurns struct{…}
type BetaAllThinkingTurns struct{…}
Type All
Type All
Accepts one of the following:
const AllAll All = "all"
All
All
Accepts one of the following:
const AllAll All = "all"
type BetaContextManagementResponse struct{…}
type BetaContextManagementResponse struct{…}
AppliedEdits []BetaContextManagementResponseAppliedEditUnion
AppliedEdits []BetaContextManagementResponseAppliedEditUnion
List of context management edits that were applied.
Accepts one of the following:
type BetaClearToolUses20250919EditResponse struct{…}
type BetaClearToolUses20250919EditResponse struct{…}
ClearedInputTokens int64
ClearedInputTokens int64
Number of input tokens cleared by this edit.
minimum0
ClearedToolUses int64
ClearedToolUses int64
Number of tool uses that were cleared.
minimum0
Type ClearToolUses20250919
Type ClearToolUses20250919
The type of context management edit applied.
Accepts one of the following:
const ClearToolUses20250919ClearToolUses20250919 ClearToolUses20250919 = "clear_tool_uses_20250919"
type BetaClearThinking20251015EditResponse struct{…}
type BetaClearThinking20251015EditResponse struct{…}
ClearedInputTokens int64
ClearedInputTokens int64
Number of input tokens cleared by this edit.
minimum0
ClearedThinkingTurns int64
ClearedThinkingTurns int64
Number of thinking turns that were cleared.
minimum0
Type ClearThinking20251015
Type ClearThinking20251015
The type of context management edit applied.
Accepts one of the following:
const ClearThinking20251015ClearThinking20251015 ClearThinking20251015 = "clear_thinking_20251015"
type BetaCountTokensContextManagementResponse struct{…}
type BetaCountTokensContextManagementResponse struct{…}
OriginalInputTokens int64
OriginalInputTokens int64
The original token count before context management was applied
type BetaDirectCaller struct{…}
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
Type Direct
Accepts one of the following:
const DirectDirect Direct = "direct"
type BetaDocumentBlock struct{…}
type BetaDocumentBlock struct{…}
Citations BetaCitationConfig
Citations BetaCitationConfig
Citation configuration for the document
Enabled bool
Source BetaDocumentBlockSourceUnion
Source BetaDocumentBlockSourceUnion
Accepts one of the following:
type BetaBase64PDFSource struct{…}
type BetaBase64PDFSource struct{…}
Data string
MediaType ApplicationPDF
MediaType ApplicationPDF
Accepts one of the following:
const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaPlainTextSource struct{…}
type BetaPlainTextSource struct{…}
Data string
MediaType TextPlain
MediaType TextPlain
Accepts one of the following:
const TextPlainTextPlain TextPlain = "text/plain"
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Title string
Title string
The title of the document
Type Document
Type Document
Accepts one of the following:
const DocumentDocument Document = "document"
type BetaFileDocumentSource struct{…}
type BetaFileDocumentSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
type BetaFileImageSource struct{…}
type BetaFileImageSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
type BetaImageBlockParamResp struct{…}
type BetaImageBlockParamResp struct{…}
Source BetaImageBlockParamSourceUnionResp
Source BetaImageBlockParamSourceUnionResp
Accepts one of the following:
type BetaBase64ImageSource struct{…}
type BetaBase64ImageSource struct{…}
Data string
MediaType BetaBase64ImageSourceMediaType
MediaType BetaBase64ImageSourceMediaType
Accepts one of the following:
const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"
const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"
const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"
const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaURLImageSource struct{…}
type BetaURLImageSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileImageSource struct{…}
type BetaFileImageSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Image
Type Image
Accepts one of the following:
const ImageImage Image = "image"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaInputJSONDelta struct{…}
type BetaInputJSONDelta struct{…}
PartialJSON string
Type InputJSONDelta
Type InputJSONDelta
Accepts one of the following:
const InputJSONDeltaInputJSONDelta InputJSONDelta = "input_json_delta"
type BetaInputTokensClearAtLeast struct{…}
type BetaInputTokensClearAtLeast struct{…}
Type InputTokens
Type InputTokens
Accepts one of the following:
const InputTokensInputTokens InputTokens = "input_tokens"
Value int64
type BetaInputTokensTrigger struct{…}
type BetaInputTokensTrigger struct{…}
Type InputTokens
Type InputTokens
Accepts one of the following:
const InputTokensInputTokens InputTokens = "input_tokens"
Value int64
type BetaJSONOutputFormat struct{…}
type BetaJSONOutputFormat struct{…}
Schema map[string, any]
Schema map[string, any]
The JSON schema of the format
Type JSONSchema
Type JSONSchema
Accepts one of the following:
const JSONSchemaJSONSchema JSONSchema = "json_schema"
type BetaMCPToolConfig struct{…}
type BetaMCPToolConfig struct{…}
Configuration for a specific tool in an MCP toolset.
DeferLoading booloptional
Enabled booloptional
type BetaMCPToolDefaultConfig struct{…}
type BetaMCPToolDefaultConfig struct{…}
Default configuration for tools in an MCP toolset.
DeferLoading booloptional
Enabled booloptional
type BetaMCPToolResultBlock struct{…}
type BetaMCPToolResultBlock struct{…}
Content BetaMCPToolResultBlockContentUnion
Content BetaMCPToolResultBlockContentUnion
Accepts one of the following:
string
Citations []BetaTextCitationUnion
Citations []BetaTextCitationUnion
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
Accepts one of the following:
type BetaCitationCharLocation struct{…}
type BetaCitationCharLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
FileID string
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
IsError bool
ToolUseID string
Type MCPToolResult
Type MCPToolResult
Accepts one of the following:
const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"
type BetaMCPToolUseBlock struct{…}
type BetaMCPToolUseBlock struct{…}
ID string
Input map[string, any]
Name string
Name string
The name of the MCP tool
ServerName string
ServerName string
The name of the MCP server
Type MCPToolUse
Type MCPToolUse
Accepts one of the following:
const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"
type BetaMCPToolUseBlockParamResp struct{…}
type BetaMCPToolUseBlockParamResp struct{…}
ID string
Input map[string, any]
Name string
ServerName string
ServerName string
The name of the MCP server
Type MCPToolUse
Type MCPToolUse
Accepts one of the following:
const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaMCPToolset struct{…}
type BetaMCPToolset struct{…}
Configuration for a group of tools from an MCP server.
Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides.
MCPServerName string
MCPServerName string
Name of the MCP server to configure tools for
maxLength255
minLength1
Type MCPToolset
Type MCPToolset
Accepts one of the following:
const MCPToolsetMCPToolset MCPToolset = "mcp_toolset"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Configuration overrides for specific tools, keyed by tool name
DeferLoading booloptional
Enabled booloptional
Default configuration applied to all tools from this server
DeferLoading booloptional
Enabled booloptional
type BetaMemoryTool20250818 struct{…}
type BetaMemoryTool20250818 struct{…}
Name Memory
Name Memory
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:
const MemoryMemory Memory = "memory"
Type Memory20250818
Type Memory20250818
Accepts one of the following:
const Memory20250818Memory20250818 Memory20250818 = "memory_20250818"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"
const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
InputExamples []map[string, any]optional
Strict booloptional
type BetaMemoryTool20250818CommandUnion interface{…}
type BetaMemoryTool20250818CommandUnion interface{…}
Accepts one of the following:
type BetaMemoryTool20250818ViewCommand struct{…}
type BetaMemoryTool20250818ViewCommand struct{…}
Command View
Command View
Command type identifier
Accepts one of the following:
const ViewView View = "view"
Path string
Path string
Path to directory or file to view
ViewRange []int64optional
ViewRange []int64optional
Optional line range for viewing specific lines
type BetaMemoryTool20250818CreateCommand struct{…}
type BetaMemoryTool20250818CreateCommand struct{…}
Command Create
Command Create
Command type identifier
Accepts one of the following:
const CreateCreate Create = "create"
FileText string
FileText string
Content to write to the file
Path string
Path string
Path where the file should be created
type BetaMemoryTool20250818StrReplaceCommand struct{…}
type BetaMemoryTool20250818StrReplaceCommand struct{…}
Command StrReplace
Command StrReplace
Command type identifier
Accepts one of the following:
const StrReplaceStrReplace StrReplace = "str_replace"
NewStr string
NewStr string
Text to replace with
OldStr string
OldStr string
Text to search for and replace
Path string
Path string
Path to the file where text should be replaced
type BetaMemoryTool20250818InsertCommand struct{…}
type BetaMemoryTool20250818InsertCommand struct{…}
Command Insert
Command Insert
Command type identifier
Accepts one of the following:
const InsertInsert Insert = "insert"
InsertLine int64
InsertLine int64
Line number where text should be inserted
minimum1
InsertText string
InsertText string
Text to insert at the specified line
Path string
Path string
Path to the file where text should be inserted
type BetaMemoryTool20250818DeleteCommand struct{…}
type BetaMemoryTool20250818DeleteCommand struct{…}
Command Delete
Command Delete
Command type identifier
Accepts one of the following:
const DeleteDelete Delete = "delete"
Path string
Path string
Path to the file or directory to delete
type BetaMemoryTool20250818RenameCommand struct{…}
type BetaMemoryTool20250818RenameCommand struct{…}
Command Rename
Command Rename
Command type identifier
Accepts one of the following:
const RenameRename Rename = "rename"
NewPath string
NewPath string
New path for the file or directory
OldPath string
OldPath string
Current path of the file or directory
type BetaMemoryTool20250818CreateCommand struct{…}
type BetaMemoryTool20250818CreateCommand struct{…}
Command Create
Command Create
Command type identifier
Accepts one of the following:
const CreateCreate Create = "create"
FileText string
FileText string
Content to write to the file
Path string
Path string
Path where the file should be created
type BetaMemoryTool20250818DeleteCommand struct{…}
type BetaMemoryTool20250818DeleteCommand struct{…}
Command Delete
Command Delete
Command type identifier
Accepts one of the following:
const DeleteDelete Delete = "delete"
Path string
Path string
Path to the file or directory to delete
type BetaMemoryTool20250818InsertCommand struct{…}
type BetaMemoryTool20250818InsertCommand struct{…}
Command Insert
Command Insert
Command type identifier
Accepts one of the following:
const InsertInsert Insert = "insert"
InsertLine int64
InsertLine int64
Line number where text should be inserted
minimum1
InsertText string
InsertText string
Text to insert at the specified line
Path string
Path string
Path to the file where text should be inserted
type BetaMemoryTool20250818RenameCommand struct{…}
type BetaMemoryTool20250818RenameCommand struct{…}
Command Rename
Command Rename
Command type identifier
Accepts one of the following:
const RenameRename Rename = "rename"
NewPath string
NewPath string
New path for the file or directory
OldPath string
OldPath string
Current path of the file or directory
type BetaMemoryTool20250818StrReplaceCommand struct{…}
type BetaMemoryTool20250818StrReplaceCommand struct{…}
Command StrReplace
Command StrReplace
Command type identifier
Accepts one of the following:
const StrReplaceStrReplace StrReplace = "str_replace"
NewStr string
NewStr string
Text to replace with
OldStr string
OldStr string
Text to search for and replace
Path string
Path string
Path to the file where text should be replaced
type BetaMemoryTool20250818ViewCommand struct{…}
type BetaMemoryTool20250818ViewCommand struct{…}
Command View
Command View
Command type identifier
Accepts one of the following:
const ViewView View = "view"
Path string
Path string
Path to directory or file to view
ViewRange []int64optional
ViewRange []int64optional
Optional line range for viewing specific lines
type BetaMessage struct{…}
type BetaMessage struct{…}
ID string
ID string
Unique object identifier.
The format and length of IDs may change over time.
Container BetaContainer
Container BetaContainer
Information about the container used in the request (for the code execution tool)
ID string
ID string
Identifier for the container used in this request
ExpiresAt Time
ExpiresAt Time
The time at which the container will expire.
formatdate-time
Skills []BetaSkill
Skills []BetaSkill
Skills loaded in the container
SkillID string
SkillID string
Skill ID
maxLength64
minLength1
Type BetaSkillType
Type BetaSkillType
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Accepts one of the following:
const BetaSkillTypeAnthropic BetaSkillType = "anthropic"
const BetaSkillTypeCustom BetaSkillType = "custom"
Version string
Version string
Skill version or 'latest' for most recent version
maxLength64
minLength1
Content []BetaContentBlockUnion
Content []BetaContentBlockUnion
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:
type BetaTextBlock struct{…}
type BetaTextBlock struct{…}
Citations []BetaTextCitationUnion
Citations []BetaTextCitationUnion
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
Accepts one of the following:
type BetaCitationCharLocation struct{…}
type BetaCitationCharLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
FileID string
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
type BetaThinkingBlock struct{…}
type BetaThinkingBlock struct{…}
Signature string
Thinking string
Type Thinking
Type Thinking
Accepts one of the following:
const ThinkingThinking Thinking = "thinking"
type BetaRedactedThinkingBlock struct{…}
type BetaRedactedThinkingBlock struct{…}
Data string
Type RedactedThinking
Type RedactedThinking
Accepts one of the following:
const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"
type BetaToolUseBlock struct{…}
type BetaToolUseBlock struct{…}
ID string
Input map[string, any]
Name string
Type ToolUse
Type ToolUse
Accepts one of the following:
const ToolUseToolUse ToolUse = "tool_use"
Caller BetaToolUseBlockCallerUnionoptional
Caller BetaToolUseBlockCallerUnionoptional
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
Type Direct
Accepts one of the following:
const DirectDirect Direct = "direct"
type BetaServerToolCaller struct{…}
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
type BetaServerToolUseBlock struct{…}
type BetaServerToolUseBlock struct{…}
ID string
Caller BetaServerToolUseBlockCallerUnion
Caller BetaServerToolUseBlockCallerUnion
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
Type Direct
Accepts one of the following:
const DirectDirect Direct = "direct"
type BetaServerToolCaller struct{…}
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
Input map[string, any]
Name BetaServerToolUseBlockName
Name BetaServerToolUseBlockName
Accepts one of the following:
const BetaServerToolUseBlockNameWebSearch BetaServerToolUseBlockName = "web_search"
const BetaServerToolUseBlockNameWebFetch BetaServerToolUseBlockName = "web_fetch"
const BetaServerToolUseBlockNameCodeExecution BetaServerToolUseBlockName = "code_execution"
const BetaServerToolUseBlockNameBashCodeExecution BetaServerToolUseBlockName = "bash_code_execution"
const BetaServerToolUseBlockNameTextEditorCodeExecution BetaServerToolUseBlockName = "text_editor_code_execution"
const BetaServerToolUseBlockNameToolSearchToolRegex BetaServerToolUseBlockName = "tool_search_tool_regex"
const BetaServerToolUseBlockNameToolSearchToolBm25 BetaServerToolUseBlockName = "tool_search_tool_bm25"
Type ServerToolUse
Type ServerToolUse
Accepts one of the following:
const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"
type BetaWebSearchToolResultBlock struct{…}
type BetaWebSearchToolResultBlock struct{…}
Accepts one of the following:
type BetaWebSearchToolResultError struct{…}
type BetaWebSearchToolResultError struct{…}
ErrorCode BetaWebSearchToolResultErrorCode
ErrorCode BetaWebSearchToolResultErrorCode
Accepts one of the following:
const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"
const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"
const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"
const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"
Type WebSearchToolResultError
Type WebSearchToolResultError
Accepts one of the following:
const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"
EncryptedContent string
PageAge string
Title string
Type WebSearchResult
Type WebSearchResult
Accepts one of the following:
const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"
URL string
ToolUseID string
Type WebSearchToolResult
Type WebSearchToolResult
Accepts one of the following:
const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"
type BetaWebFetchToolResultBlock struct{…}
type BetaWebFetchToolResultBlock struct{…}
Content BetaWebFetchToolResultBlockContentUnion
Content BetaWebFetchToolResultBlockContentUnion
Accepts one of the following:
type BetaWebFetchToolResultErrorBlock struct{…}
type BetaWebFetchToolResultErrorBlock struct{…}
ErrorCode BetaWebFetchToolResultErrorCode
ErrorCode BetaWebFetchToolResultErrorCode
Accepts one of the following:
const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"
const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"
const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"
const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"
const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"
const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"
Type WebFetchToolResultError
Type WebFetchToolResultError
Accepts one of the following:
const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"
type BetaWebFetchBlock struct{…}
type BetaWebFetchBlock struct{…}
Content BetaDocumentBlock
Content BetaDocumentBlock
Citations BetaCitationConfig
Citations BetaCitationConfig
Citation configuration for the document
Enabled bool
Source BetaDocumentBlockSourceUnion
Source BetaDocumentBlockSourceUnion
Accepts one of the following:
type BetaBase64PDFSource struct{…}
type BetaBase64PDFSource struct{…}
Data string
MediaType ApplicationPDF
MediaType ApplicationPDF
Accepts one of the following:
const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaPlainTextSource struct{…}
type BetaPlainTextSource struct{…}
Data string
MediaType TextPlain
MediaType TextPlain
Accepts one of the following:
const TextPlainTextPlain TextPlain = "text/plain"
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Title string
Title string
The title of the document
Type Document
Type Document
Accepts one of the following:
const DocumentDocument Document = "document"
RetrievedAt string
RetrievedAt string
ISO 8601 timestamp when the content was retrieved
Type WebFetchResult
Type WebFetchResult
Accepts one of the following:
const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"
URL string
URL string
Fetched content URL
ToolUseID string
Type WebFetchToolResult
Type WebFetchToolResult
Accepts one of the following:
const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"
type BetaCodeExecutionToolResultBlock struct{…}
type BetaCodeExecutionToolResultBlock struct{…}
Accepts one of the following:
type BetaCodeExecutionToolResultError struct{…}
type BetaCodeExecutionToolResultError struct{…}
ErrorCode BetaCodeExecutionToolResultErrorCode
ErrorCode BetaCodeExecutionToolResultErrorCode
Accepts one of the following:
const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"
const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"
const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"
const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"
Type CodeExecutionToolResultError
Type CodeExecutionToolResultError
Accepts one of the following:
const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"
type BetaCodeExecutionResultBlock struct{…}
type BetaCodeExecutionResultBlock struct{…}
Content []BetaCodeExecutionOutputBlock
Content []BetaCodeExecutionOutputBlock
FileID string
Type CodeExecutionOutput
Type CodeExecutionOutput
Accepts one of the following:
const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type CodeExecutionResult
Type CodeExecutionResult
Accepts one of the following:
const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"
ToolUseID string
Type CodeExecutionToolResult
Type CodeExecutionToolResult
Accepts one of the following:
const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"
type BetaBashCodeExecutionToolResultBlock struct{…}
type BetaBashCodeExecutionToolResultBlock struct{…}
Content BetaBashCodeExecutionToolResultBlockContentUnion
Content BetaBashCodeExecutionToolResultBlockContentUnion
Accepts one of the following:
type BetaBashCodeExecutionToolResultError struct{…}
type BetaBashCodeExecutionToolResultError struct{…}
ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode
ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode
Accepts one of the following:
const BetaBashCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"
const BetaBashCodeExecutionToolResultErrorErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorErrorCode = "unavailable"
const BetaBashCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorErrorCode = "too_many_requests"
const BetaBashCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"
const BetaBashCodeExecutionToolResultErrorErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorErrorCode = "output_file_too_large"
Type BashCodeExecutionToolResultError
Type BashCodeExecutionToolResultError
Accepts one of the following:
const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"
type BetaBashCodeExecutionResultBlock struct{…}
type BetaBashCodeExecutionResultBlock struct{…}
Content []BetaBashCodeExecutionOutputBlock
Content []BetaBashCodeExecutionOutputBlock
FileID string
Type BashCodeExecutionOutput
Type BashCodeExecutionOutput
Accepts one of the following:
const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type BashCodeExecutionResult
Type BashCodeExecutionResult
Accepts one of the following:
const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"
ToolUseID string
Type BashCodeExecutionToolResult
Type BashCodeExecutionToolResult
Accepts one of the following:
const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"
type BetaTextEditorCodeExecutionToolResultBlock struct{…}
type BetaTextEditorCodeExecutionToolResultBlock struct{…}
Content BetaTextEditorCodeExecutionToolResultBlockContentUnion
Content BetaTextEditorCodeExecutionToolResultBlockContentUnion
Accepts one of the following:
type BetaTextEditorCodeExecutionToolResultError struct{…}
type BetaTextEditorCodeExecutionToolResultError struct{…}
ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode
ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode
Accepts one of the following:
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorErrorCode = "unavailable"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorErrorCode = "too_many_requests"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorErrorCode = "file_not_found"
ErrorMessage string
Type TextEditorCodeExecutionToolResultError
Type TextEditorCodeExecutionToolResultError
Accepts one of the following:
const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"
type BetaTextEditorCodeExecutionViewResultBlock struct{…}
type BetaTextEditorCodeExecutionViewResultBlock struct{…}
Content string
FileType BetaTextEditorCodeExecutionViewResultBlockFileType
FileType BetaTextEditorCodeExecutionViewResultBlockFileType
Accepts one of the following:
const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"
const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"
const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"
NumLines int64
StartLine int64
TotalLines int64
Type TextEditorCodeExecutionViewResult
Type TextEditorCodeExecutionViewResult
Accepts one of the following:
const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"
type BetaTextEditorCodeExecutionCreateResultBlock struct{…}
type BetaTextEditorCodeExecutionCreateResultBlock struct{…}
IsFileUpdate bool
Type TextEditorCodeExecutionCreateResult
Type TextEditorCodeExecutionCreateResult
Accepts one of the following:
const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"
type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}
type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}
Lines []string
NewLines int64
NewStart int64
OldLines int64
OldStart int64
Type TextEditorCodeExecutionStrReplaceResult
Type TextEditorCodeExecutionStrReplaceResult
Accepts one of the following:
const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"
ToolUseID string
Type TextEditorCodeExecutionToolResult
Type TextEditorCodeExecutionToolResult
Accepts one of the following:
const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"
type BetaToolSearchToolResultBlock struct{…}
type BetaToolSearchToolResultBlock struct{…}
Content BetaToolSearchToolResultBlockContentUnion
Content BetaToolSearchToolResultBlockContentUnion
Accepts one of the following:
type BetaToolSearchToolResultError struct{…}
type BetaToolSearchToolResultError struct{…}
ErrorCode BetaToolSearchToolResultErrorErrorCode
ErrorCode BetaToolSearchToolResultErrorErrorCode
Accepts one of the following:
const BetaToolSearchToolResultErrorErrorCodeInvalidToolInput BetaToolSearchToolResultErrorErrorCode = "invalid_tool_input"
const BetaToolSearchToolResultErrorErrorCodeUnavailable BetaToolSearchToolResultErrorErrorCode = "unavailable"
const BetaToolSearchToolResultErrorErrorCodeTooManyRequests BetaToolSearchToolResultErrorErrorCode = "too_many_requests"
const BetaToolSearchToolResultErrorErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorErrorCode = "execution_time_exceeded"
ErrorMessage string
Type ToolSearchToolResultError
Type ToolSearchToolResultError
Accepts one of the following:
const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"
type BetaToolSearchToolSearchResultBlock struct{…}
type BetaToolSearchToolSearchResultBlock struct{…}
ToolReferences []BetaToolReferenceBlock
ToolReferences []BetaToolReferenceBlock
ToolName string
Type ToolReference
Type ToolReference
Accepts one of the following:
const ToolReferenceToolReference ToolReference = "tool_reference"
Type ToolSearchToolSearchResult
Type ToolSearchToolSearchResult
Accepts one of the following:
const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"
ToolUseID string
Type ToolSearchToolResult
Type ToolSearchToolResult
Accepts one of the following:
const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"
type BetaMCPToolUseBlock struct{…}
type BetaMCPToolUseBlock struct{…}
ID string
Input map[string, any]
Name string
Name string
The name of the MCP tool
ServerName string
ServerName string
The name of the MCP server
Type MCPToolUse
Type MCPToolUse
Accepts one of the following:
const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"
type BetaMCPToolResultBlock struct{…}
type BetaMCPToolResultBlock struct{…}
Content BetaMCPToolResultBlockContentUnion
Content BetaMCPToolResultBlockContentUnion
Accepts one of the following:
string
Citations []BetaTextCitationUnion
Citations []BetaTextCitationUnion
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
Accepts one of the following:
type BetaCitationCharLocation struct{…}
type BetaCitationCharLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
FileID string
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
IsError bool
ToolUseID string
Type MCPToolResult
Type MCPToolResult
Accepts one of the following:
const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"
type BetaContainerUploadBlock struct{…}
type BetaContainerUploadBlock struct{…}
Response model for a file uploaded to the container.
FileID string
Type ContainerUpload
Type ContainerUpload
Accepts one of the following:
const ContainerUploadContainerUpload ContainerUpload = "container_upload"
ContextManagement BetaContextManagementResponse
ContextManagement BetaContextManagementResponse
Context management response.
Information about context management strategies applied during the request.
AppliedEdits []BetaContextManagementResponseAppliedEditUnion
AppliedEdits []BetaContextManagementResponseAppliedEditUnion
List of context management edits that were applied.
Accepts one of the following:
type BetaClearToolUses20250919EditResponse struct{…}
type BetaClearToolUses20250919EditResponse struct{…}
ClearedInputTokens int64
ClearedInputTokens int64
Number of input tokens cleared by this edit.
minimum0
ClearedToolUses int64
ClearedToolUses int64
Number of tool uses that were cleared.
minimum0
Type ClearToolUses20250919
Type ClearToolUses20250919
The type of context management edit applied.
Accepts one of the following:
const ClearToolUses20250919ClearToolUses20250919 ClearToolUses20250919 = "clear_tool_uses_20250919"
type BetaClearThinking20251015EditResponse struct{…}
type BetaClearThinking20251015EditResponse struct{…}
ClearedInputTokens int64
ClearedInputTokens int64
Number of input tokens cleared by this edit.
minimum0
ClearedThinkingTurns int64
ClearedThinkingTurns int64
Number of thinking turns that were cleared.
minimum0
Type ClearThinking20251015
Type ClearThinking20251015
The type of context management edit applied.
Accepts one of the following:
const ClearThinking20251015ClearThinking20251015 ClearThinking20251015 = "clear_thinking_20251015"
Model Model
Model Model
The model that will complete your prompt.
See models for additional details and options.
Accepts one of the following:
type Model string
type Model string
The model that will complete your prompt.
See models for additional details and options.
Accepts one of the following:
const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"
const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"
Premium model combining maximum intelligence with practical performance
const ModelClaudeOpus4_5 Model = "claude-opus-4-5"
const ModelClaudeOpus4_5 Model = "claude-opus-4-5"
Premium model combining maximum intelligence with practical performance
const ModelClaude3_7SonnetLatest Model = "claude-3-7-sonnet-latest"
const ModelClaude3_7SonnetLatest Model = "claude-3-7-sonnet-latest"
High-performance model with early extended thinking
const ModelClaude3_7Sonnet20250219 Model = "claude-3-7-sonnet-20250219"
const ModelClaude3_7Sonnet20250219 Model = "claude-3-7-sonnet-20250219"
High-performance model with early extended thinking
const ModelClaude3_5HaikuLatest Model = "claude-3-5-haiku-latest"
const ModelClaude3_5HaikuLatest Model = "claude-3-5-haiku-latest"
Fastest and most compact model for near-instant responsiveness
const ModelClaude3_5Haiku20241022 Model = "claude-3-5-haiku-20241022"
const ModelClaude3_5Haiku20241022 Model = "claude-3-5-haiku-20241022"
Our fastest model
const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"
const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"
Hybrid model, capable of near-instant responses and extended thinking
const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"
const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"
Hybrid model, capable of near-instant responses and extended thinking
const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"
const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"
High-performance model with extended thinking
const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"
const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"
High-performance model with extended thinking
const ModelClaude4Sonnet20250514 Model = "claude-4-sonnet-20250514"
const ModelClaude4Sonnet20250514 Model = "claude-4-sonnet-20250514"
High-performance model with extended thinking
const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"
const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"
Our best model for real-world agents and coding
const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"
const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"
Our best model for real-world agents and coding
const ModelClaudeOpus4_0 Model = "claude-opus-4-0"
const ModelClaudeOpus4_0 Model = "claude-opus-4-0"
Our most capable model
const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"
const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"
Our most capable model
const ModelClaude4Opus20250514 Model = "claude-4-opus-20250514"
const ModelClaude4Opus20250514 Model = "claude-4-opus-20250514"
Our most capable model
const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"
const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"
Our most capable model
const ModelClaude3OpusLatest Model = "claude-3-opus-latest"
const ModelClaude3OpusLatest Model = "claude-3-opus-latest"
Excels at writing and complex tasks
const ModelClaude_3_Opus_20240229 Model = "claude-3-opus-20240229"
const ModelClaude_3_Opus_20240229 Model = "claude-3-opus-20240229"
Excels at writing and complex tasks
const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"
const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"
Our previous most fast and cost-effective
string
Role Assistant
Role Assistant
Conversational role of the generated message.
This will always be "assistant".
Accepts one of the following:
const AssistantAssistant Assistant = "assistant"
StopReason BetaStopReason
StopReason BetaStopReason
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
Accepts one of the following:
StopSequence string
StopSequence 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 Message
Type Message
Object type.
For Messages, this is always "message".
Accepts one of the following:
const MessageMessage Message = "message"
Usage BetaUsage
Usage BetaUsage
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
CacheCreation BetaCacheCreation
CacheCreation BetaCacheCreation
Breakdown of cached tokens by TTL
Ephemeral1hInputTokens int64
Ephemeral1hInputTokens int64
The number of input tokens used to create the 1 hour cache entry.
minimum0
Ephemeral5mInputTokens int64
Ephemeral5mInputTokens int64
The number of input tokens used to create the 5 minute cache entry.
minimum0
CacheCreationInputTokens int64
CacheCreationInputTokens int64
The number of input tokens used to create the cache entry.
minimum0
CacheReadInputTokens int64
CacheReadInputTokens int64
The number of input tokens read from the cache.
minimum0
InputTokens int64
InputTokens int64
The number of input tokens which were used.
minimum0
OutputTokens int64
OutputTokens int64
The number of output tokens which were used.
minimum0
ServerToolUse BetaServerToolUsage
ServerToolUse BetaServerToolUsage
The number of server tool requests.
WebFetchRequests int64
WebFetchRequests int64
The number of web fetch tool requests.
minimum0
WebSearchRequests int64
WebSearchRequests int64
The number of web search tool requests.
minimum0
ServiceTier BetaUsageServiceTier
ServiceTier BetaUsageServiceTier
If the request used the priority, standard, or batch tier.
Accepts one of the following:
const BetaUsageServiceTierStandard BetaUsageServiceTier = "standard"
const BetaUsageServiceTierPriority BetaUsageServiceTier = "priority"
const BetaUsageServiceTierBatch BetaUsageServiceTier = "batch"
type BetaMessageDeltaUsage struct{…}
type BetaMessageDeltaUsage struct{…}
CacheCreationInputTokens int64
CacheCreationInputTokens int64
The cumulative number of input tokens used to create the cache entry.
minimum0
CacheReadInputTokens int64
CacheReadInputTokens int64
The cumulative number of input tokens read from the cache.
minimum0
InputTokens int64
InputTokens int64
The cumulative number of input tokens which were used.
minimum0
OutputTokens int64
OutputTokens int64
The cumulative number of output tokens which were used.
ServerToolUse BetaServerToolUsage
ServerToolUse BetaServerToolUsage
The number of server tool requests.
WebFetchRequests int64
WebFetchRequests int64
The number of web fetch tool requests.
minimum0
WebSearchRequests int64
WebSearchRequests int64
The number of web search tool requests.
minimum0
type BetaMessageParamResp struct{…}
type BetaMessageParamResp struct{…}
Content []BetaContentBlockParamUnionResp
Content []BetaContentBlockParamUnionResp
Accepts one of the following:
Accepts one of the following:
type BetaTextBlockParamResp struct{…}
type BetaTextBlockParamResp struct{…}
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
type BetaImageBlockParamResp struct{…}
type BetaImageBlockParamResp struct{…}
Source BetaImageBlockParamSourceUnionResp
Source BetaImageBlockParamSourceUnionResp
Accepts one of the following:
type BetaBase64ImageSource struct{…}
type BetaBase64ImageSource struct{…}
Data string
MediaType BetaBase64ImageSourceMediaType
MediaType BetaBase64ImageSourceMediaType
Accepts one of the following:
const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"
const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"
const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"
const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaURLImageSource struct{…}
type BetaURLImageSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileImageSource struct{…}
type BetaFileImageSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Image
Type Image
Accepts one of the following:
const ImageImage Image = "image"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaRequestDocumentBlock struct{…}
type BetaRequestDocumentBlock struct{…}
Source BetaRequestDocumentBlockSourceUnion
Source BetaRequestDocumentBlockSourceUnion
Accepts one of the following:
type BetaBase64PDFSource struct{…}
type BetaBase64PDFSource struct{…}
Data string
MediaType ApplicationPDF
MediaType ApplicationPDF
Accepts one of the following:
const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaPlainTextSource struct{…}
type BetaPlainTextSource struct{…}
Data string
MediaType TextPlain
MediaType TextPlain
Accepts one of the following:
const TextPlainTextPlain TextPlain = "text/plain"
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
type BetaContentBlockSource struct{…}
type BetaContentBlockSource struct{…}
Content BetaContentBlockSourceContentUnion
Content BetaContentBlockSourceContentUnion
Accepts one of the following:
string
Accepts one of the following:
type BetaTextBlockParamResp struct{…}
type BetaTextBlockParamResp struct{…}
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
type BetaImageBlockParamResp struct{…}
type BetaImageBlockParamResp struct{…}
Source BetaImageBlockParamSourceUnionResp
Source BetaImageBlockParamSourceUnionResp
Accepts one of the following:
type BetaBase64ImageSource struct{…}
type BetaBase64ImageSource struct{…}
Data string
MediaType BetaBase64ImageSourceMediaType
MediaType BetaBase64ImageSourceMediaType
Accepts one of the following:
const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"
const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"
const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"
const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaURLImageSource struct{…}
type BetaURLImageSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileImageSource struct{…}
type BetaFileImageSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Image
Type Image
Accepts one of the following:
const ImageImage Image = "image"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Type Content
Type Content
Accepts one of the following:
const ContentContent Content = "content"
type BetaURLPDFSource struct{…}
type BetaURLPDFSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileDocumentSource struct{…}
type BetaFileDocumentSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Document
Type Document
Accepts one of the following:
const DocumentDocument Document = "document"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Enabled booloptional
Context stringoptional
Title stringoptional
type BetaSearchResultBlockParamResp struct{…}
type BetaSearchResultBlockParamResp struct{…}
Content []BetaTextBlockParamResp
Content []BetaTextBlockParamResp
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Source string
Title string
Type SearchResult
Type SearchResult
Accepts one of the following:
const SearchResultSearchResult SearchResult = "search_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Enabled booloptional
type BetaThinkingBlockParamResp struct{…}
type BetaThinkingBlockParamResp struct{…}
Signature string
Thinking string
Type Thinking
Type Thinking
Accepts one of the following:
const ThinkingThinking Thinking = "thinking"
type BetaRedactedThinkingBlockParamResp struct{…}
type BetaRedactedThinkingBlockParamResp struct{…}
Data string
Type RedactedThinking
Type RedactedThinking
Accepts one of the following:
const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"
type BetaToolUseBlockParamResp struct{…}
type BetaToolUseBlockParamResp struct{…}
ID string
Input map[string, any]
Name string
Type ToolUse
Type ToolUse
Accepts one of the following:
const ToolUseToolUse ToolUse = "tool_use"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Caller BetaToolUseBlockParamCallerUnionRespoptional
Caller BetaToolUseBlockParamCallerUnionRespoptional
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
Type Direct
Accepts one of the following:
const DirectDirect Direct = "direct"
type BetaServerToolCaller struct{…}
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
type BetaToolResultBlockParamResp struct{…}
type BetaToolResultBlockParamResp struct{…}
ToolUseID string
Type ToolResult
Type ToolResult
Accepts one of the following:
const ToolResultToolResult ToolResult = "tool_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Content []BetaToolResultBlockParamContentUnionRespoptional
Content []BetaToolResultBlockParamContentUnionRespoptional
Accepts one of the following:
[]BetaToolResultBlockParamContentUnionResp
[]BetaToolResultBlockParamContentUnionResp
Accepts one of the following:
type BetaTextBlockParamResp struct{…}
type BetaTextBlockParamResp struct{…}
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
type BetaImageBlockParamResp struct{…}
type BetaImageBlockParamResp struct{…}
Source BetaImageBlockParamSourceUnionResp
Source BetaImageBlockParamSourceUnionResp
Accepts one of the following:
type BetaBase64ImageSource struct{…}
type BetaBase64ImageSource struct{…}
Data string
MediaType BetaBase64ImageSourceMediaType
MediaType BetaBase64ImageSourceMediaType
Accepts one of the following:
const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"
const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"
const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"
const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaURLImageSource struct{…}
type BetaURLImageSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileImageSource struct{…}
type BetaFileImageSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Image
Type Image
Accepts one of the following:
const ImageImage Image = "image"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaSearchResultBlockParamResp struct{…}
type BetaSearchResultBlockParamResp struct{…}
Content []BetaTextBlockParamResp
Content []BetaTextBlockParamResp
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Source string
Title string
Type SearchResult
Type SearchResult
Accepts one of the following:
const SearchResultSearchResult SearchResult = "search_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Enabled booloptional
type BetaRequestDocumentBlock struct{…}
type BetaRequestDocumentBlock struct{…}
Source BetaRequestDocumentBlockSourceUnion
Source BetaRequestDocumentBlockSourceUnion
Accepts one of the following:
type BetaBase64PDFSource struct{…}
type BetaBase64PDFSource struct{…}
Data string
MediaType ApplicationPDF
MediaType ApplicationPDF
Accepts one of the following:
const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaPlainTextSource struct{…}
type BetaPlainTextSource struct{…}
Data string
MediaType TextPlain
MediaType TextPlain
Accepts one of the following:
const TextPlainTextPlain TextPlain = "text/plain"
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
type BetaContentBlockSource struct{…}
type BetaContentBlockSource struct{…}
Content BetaContentBlockSourceContentUnion
Content BetaContentBlockSourceContentUnion
Accepts one of the following:
string
Accepts one of the following:
type BetaTextBlockParamResp struct{…}
type BetaTextBlockParamResp struct{…}
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
type BetaImageBlockParamResp struct{…}
type BetaImageBlockParamResp struct{…}
Source BetaImageBlockParamSourceUnionResp
Source BetaImageBlockParamSourceUnionResp
Accepts one of the following:
type BetaBase64ImageSource struct{…}
type BetaBase64ImageSource struct{…}
Data string
MediaType BetaBase64ImageSourceMediaType
MediaType BetaBase64ImageSourceMediaType
Accepts one of the following:
const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"
const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"
const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"
const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaURLImageSource struct{…}
type BetaURLImageSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileImageSource struct{…}
type BetaFileImageSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Image
Type Image
Accepts one of the following:
const ImageImage Image = "image"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Type Content
Type Content
Accepts one of the following:
const ContentContent Content = "content"
type BetaURLPDFSource struct{…}
type BetaURLPDFSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileDocumentSource struct{…}
type BetaFileDocumentSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Document
Type Document
Accepts one of the following:
const DocumentDocument Document = "document"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Enabled booloptional
Context stringoptional
Title stringoptional
type BetaToolReferenceBlockParamResp struct{…}
type BetaToolReferenceBlockParamResp struct{…}
Tool reference block that can be included in tool_result content.
ToolName string
Type ToolReference
Type ToolReference
Accepts one of the following:
const ToolReferenceToolReference ToolReference = "tool_reference"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
IsError booloptional
type BetaServerToolUseBlockParamResp struct{…}
type BetaServerToolUseBlockParamResp struct{…}
ID string
Input map[string, any]
Name BetaServerToolUseBlockParamName
Name BetaServerToolUseBlockParamName
Accepts one of the following:
const BetaServerToolUseBlockParamNameWebSearch BetaServerToolUseBlockParamName = "web_search"
const BetaServerToolUseBlockParamNameWebFetch BetaServerToolUseBlockParamName = "web_fetch"
const BetaServerToolUseBlockParamNameCodeExecution BetaServerToolUseBlockParamName = "code_execution"
const BetaServerToolUseBlockParamNameBashCodeExecution BetaServerToolUseBlockParamName = "bash_code_execution"
const BetaServerToolUseBlockParamNameTextEditorCodeExecution BetaServerToolUseBlockParamName = "text_editor_code_execution"
const BetaServerToolUseBlockParamNameToolSearchToolRegex BetaServerToolUseBlockParamName = "tool_search_tool_regex"
const BetaServerToolUseBlockParamNameToolSearchToolBm25 BetaServerToolUseBlockParamName = "tool_search_tool_bm25"
Type ServerToolUse
Type ServerToolUse
Accepts one of the following:
const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Caller BetaServerToolUseBlockParamCallerUnionRespoptional
Caller BetaServerToolUseBlockParamCallerUnionRespoptional
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
Type Direct
Accepts one of the following:
const DirectDirect Direct = "direct"
type BetaServerToolCaller struct{…}
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
type BetaWebSearchToolResultBlockParamResp struct{…}
type BetaWebSearchToolResultBlockParamResp struct{…}
Accepts one of the following:
EncryptedContent string
Title string
Type WebSearchResult
Type WebSearchResult
Accepts one of the following:
const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"
URL string
PageAge stringoptional
type BetaWebSearchToolRequestError struct{…}
type BetaWebSearchToolRequestError struct{…}
ErrorCode BetaWebSearchToolResultErrorCode
ErrorCode BetaWebSearchToolResultErrorCode
Accepts one of the following:
const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"
const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"
const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"
const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"
Type WebSearchToolResultError
Type WebSearchToolResultError
Accepts one of the following:
const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"
ToolUseID string
Type WebSearchToolResult
Type WebSearchToolResult
Accepts one of the following:
const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaWebFetchToolResultBlockParamResp struct{…}
type BetaWebFetchToolResultBlockParamResp struct{…}
Content BetaWebFetchToolResultBlockParamContentUnionResp
Content BetaWebFetchToolResultBlockParamContentUnionResp
Accepts one of the following:
type BetaWebFetchToolResultErrorBlockParamResp struct{…}
type BetaWebFetchToolResultErrorBlockParamResp struct{…}
ErrorCode BetaWebFetchToolResultErrorCode
ErrorCode BetaWebFetchToolResultErrorCode
Accepts one of the following:
const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"
const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"
const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"
const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"
const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"
const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"
Type WebFetchToolResultError
Type WebFetchToolResultError
Accepts one of the following:
const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"
type BetaWebFetchBlockParamResp struct{…}
type BetaWebFetchBlockParamResp struct{…}
Content BetaRequestDocumentBlock
Content BetaRequestDocumentBlock
Source BetaRequestDocumentBlockSourceUnion
Source BetaRequestDocumentBlockSourceUnion
Accepts one of the following:
type BetaBase64PDFSource struct{…}
type BetaBase64PDFSource struct{…}
Data string
MediaType ApplicationPDF
MediaType ApplicationPDF
Accepts one of the following:
const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaPlainTextSource struct{…}
type BetaPlainTextSource struct{…}
Data string
MediaType TextPlain
MediaType TextPlain
Accepts one of the following:
const TextPlainTextPlain TextPlain = "text/plain"
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
type BetaContentBlockSource struct{…}
type BetaContentBlockSource struct{…}
Content BetaContentBlockSourceContentUnion
Content BetaContentBlockSourceContentUnion
Accepts one of the following:
string
Accepts one of the following:
type BetaTextBlockParamResp struct{…}
type BetaTextBlockParamResp struct{…}
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
type BetaImageBlockParamResp struct{…}
type BetaImageBlockParamResp struct{…}
Source BetaImageBlockParamSourceUnionResp
Source BetaImageBlockParamSourceUnionResp
Accepts one of the following:
type BetaBase64ImageSource struct{…}
type BetaBase64ImageSource struct{…}
Data string
MediaType BetaBase64ImageSourceMediaType
MediaType BetaBase64ImageSourceMediaType
Accepts one of the following:
const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"
const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"
const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"
const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaURLImageSource struct{…}
type BetaURLImageSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileImageSource struct{…}
type BetaFileImageSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Image
Type Image
Accepts one of the following:
const ImageImage Image = "image"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Type Content
Type Content
Accepts one of the following:
const ContentContent Content = "content"
type BetaURLPDFSource struct{…}
type BetaURLPDFSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileDocumentSource struct{…}
type BetaFileDocumentSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Document
Type Document
Accepts one of the following:
const DocumentDocument Document = "document"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Enabled booloptional
Context stringoptional
Title stringoptional
Type WebFetchResult
Type WebFetchResult
Accepts one of the following:
const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"
URL string
URL string
Fetched content URL
RetrievedAt stringoptional
RetrievedAt stringoptional
ISO 8601 timestamp when the content was retrieved
ToolUseID string
Type WebFetchToolResult
Type WebFetchToolResult
Accepts one of the following:
const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaCodeExecutionToolResultBlockParamResp struct{…}
type BetaCodeExecutionToolResultBlockParamResp struct{…}
Accepts one of the following:
type BetaCodeExecutionToolResultErrorParamResp struct{…}
type BetaCodeExecutionToolResultErrorParamResp struct{…}
ErrorCode BetaCodeExecutionToolResultErrorCode
ErrorCode BetaCodeExecutionToolResultErrorCode
Accepts one of the following:
const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"
const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"
const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"
const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"
Type CodeExecutionToolResultError
Type CodeExecutionToolResultError
Accepts one of the following:
const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"
type BetaCodeExecutionResultBlockParamResp struct{…}
type BetaCodeExecutionResultBlockParamResp struct{…}
Content []BetaCodeExecutionOutputBlockParamResp
Content []BetaCodeExecutionOutputBlockParamResp
FileID string
Type CodeExecutionOutput
Type CodeExecutionOutput
Accepts one of the following:
const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type CodeExecutionResult
Type CodeExecutionResult
Accepts one of the following:
const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"
ToolUseID string
Type CodeExecutionToolResult
Type CodeExecutionToolResult
Accepts one of the following:
const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaBashCodeExecutionToolResultBlockParamResp struct{…}
type BetaBashCodeExecutionToolResultBlockParamResp struct{…}
Content BetaBashCodeExecutionToolResultBlockParamContentUnionResp
Content BetaBashCodeExecutionToolResultBlockParamContentUnionResp
Accepts one of the following:
type BetaBashCodeExecutionToolResultErrorParamResp struct{…}
type BetaBashCodeExecutionToolResultErrorParamResp struct{…}
ErrorCode BetaBashCodeExecutionToolResultErrorParamErrorCode
ErrorCode BetaBashCodeExecutionToolResultErrorParamErrorCode
Accepts one of the following:
const BetaBashCodeExecutionToolResultErrorParamErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorParamErrorCode = "invalid_tool_input"
const BetaBashCodeExecutionToolResultErrorParamErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorParamErrorCode = "unavailable"
const BetaBashCodeExecutionToolResultErrorParamErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorParamErrorCode = "too_many_requests"
const BetaBashCodeExecutionToolResultErrorParamErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorParamErrorCode = "execution_time_exceeded"
const BetaBashCodeExecutionToolResultErrorParamErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorParamErrorCode = "output_file_too_large"
Type BashCodeExecutionToolResultError
Type BashCodeExecutionToolResultError
Accepts one of the following:
const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"
type BetaBashCodeExecutionResultBlockParamResp struct{…}
type BetaBashCodeExecutionResultBlockParamResp struct{…}
FileID string
Type BashCodeExecutionOutput
Type BashCodeExecutionOutput
Accepts one of the following:
const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type BashCodeExecutionResult
Type BashCodeExecutionResult
Accepts one of the following:
const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"
ToolUseID string
Type BashCodeExecutionToolResult
Type BashCodeExecutionToolResult
Accepts one of the following:
const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaTextEditorCodeExecutionToolResultBlockParamResp struct{…}
type BetaTextEditorCodeExecutionToolResultBlockParamResp struct{…}
Content BetaTextEditorCodeExecutionToolResultBlockParamContentUnionResp
Content BetaTextEditorCodeExecutionToolResultBlockParamContentUnionResp
Accepts one of the following:
type BetaTextEditorCodeExecutionToolResultErrorParamResp struct{…}
type BetaTextEditorCodeExecutionToolResultErrorParamResp struct{…}
ErrorCode BetaTextEditorCodeExecutionToolResultErrorParamErrorCode
ErrorCode BetaTextEditorCodeExecutionToolResultErrorParamErrorCode
Accepts one of the following:
const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "invalid_tool_input"
const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "unavailable"
const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "too_many_requests"
const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "execution_time_exceeded"
const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "file_not_found"
Type TextEditorCodeExecutionToolResultError
Type TextEditorCodeExecutionToolResultError
Accepts one of the following:
const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"
ErrorMessage stringoptional
type BetaTextEditorCodeExecutionViewResultBlockParamResp struct{…}
type BetaTextEditorCodeExecutionViewResultBlockParamResp struct{…}
Content string
FileType BetaTextEditorCodeExecutionViewResultBlockParamFileType
FileType BetaTextEditorCodeExecutionViewResultBlockParamFileType
Accepts one of the following:
const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeText BetaTextEditorCodeExecutionViewResultBlockParamFileType = "text"
const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeImage BetaTextEditorCodeExecutionViewResultBlockParamFileType = "image"
const BetaTextEditorCodeExecutionViewResultBlockParamFileTypePDF BetaTextEditorCodeExecutionViewResultBlockParamFileType = "pdf"
Type TextEditorCodeExecutionViewResult
Type TextEditorCodeExecutionViewResult
Accepts one of the following:
const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"
NumLines int64optional
StartLine int64optional
TotalLines int64optional
type BetaTextEditorCodeExecutionCreateResultBlockParamResp struct{…}
type BetaTextEditorCodeExecutionCreateResultBlockParamResp struct{…}
IsFileUpdate bool
Type TextEditorCodeExecutionCreateResult
Type TextEditorCodeExecutionCreateResult
Accepts one of the following:
const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"
type BetaTextEditorCodeExecutionStrReplaceResultBlockParamResp struct{…}
type BetaTextEditorCodeExecutionStrReplaceResultBlockParamResp struct{…}
Type TextEditorCodeExecutionStrReplaceResult
Type TextEditorCodeExecutionStrReplaceResult
Accepts one of the following:
const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"
Lines []stringoptional
NewLines int64optional
NewStart int64optional
OldLines int64optional
OldStart int64optional
ToolUseID string
Type TextEditorCodeExecutionToolResult
Type TextEditorCodeExecutionToolResult
Accepts one of the following:
const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaToolSearchToolResultBlockParamResp struct{…}
type BetaToolSearchToolResultBlockParamResp struct{…}
Content BetaToolSearchToolResultBlockParamContentUnionResp
Content BetaToolSearchToolResultBlockParamContentUnionResp
Accepts one of the following:
type BetaToolSearchToolResultErrorParamResp struct{…}
type BetaToolSearchToolResultErrorParamResp struct{…}
ErrorCode BetaToolSearchToolResultErrorParamErrorCode
ErrorCode BetaToolSearchToolResultErrorParamErrorCode
Accepts one of the following:
const BetaToolSearchToolResultErrorParamErrorCodeInvalidToolInput BetaToolSearchToolResultErrorParamErrorCode = "invalid_tool_input"
const BetaToolSearchToolResultErrorParamErrorCodeUnavailable BetaToolSearchToolResultErrorParamErrorCode = "unavailable"
const BetaToolSearchToolResultErrorParamErrorCodeTooManyRequests BetaToolSearchToolResultErrorParamErrorCode = "too_many_requests"
const BetaToolSearchToolResultErrorParamErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorParamErrorCode = "execution_time_exceeded"
Type ToolSearchToolResultError
Type ToolSearchToolResultError
Accepts one of the following:
const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"
type BetaToolSearchToolSearchResultBlockParamResp struct{…}
type BetaToolSearchToolSearchResultBlockParamResp struct{…}
ToolReferences []BetaToolReferenceBlockParamResp
ToolReferences []BetaToolReferenceBlockParamResp
ToolName string
Type ToolReference
Type ToolReference
Accepts one of the following:
const ToolReferenceToolReference ToolReference = "tool_reference"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Type ToolSearchToolSearchResult
Type ToolSearchToolSearchResult
Accepts one of the following:
const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"
ToolUseID string
Type ToolSearchToolResult
Type ToolSearchToolResult
Accepts one of the following:
const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaMCPToolUseBlockParamResp struct{…}
type BetaMCPToolUseBlockParamResp struct{…}
ID string
Input map[string, any]
Name string
ServerName string
ServerName string
The name of the MCP server
Type MCPToolUse
Type MCPToolUse
Accepts one of the following:
const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaRequestMCPToolResultBlockParamResp struct{…}
type BetaRequestMCPToolResultBlockParamResp struct{…}
ToolUseID string
Type MCPToolResult
Type MCPToolResult
Accepts one of the following:
const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Content BetaRequestMCPToolResultBlockParamContentUnionRespoptional
Content BetaRequestMCPToolResultBlockParamContentUnionRespoptional
Accepts one of the following:
string
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
IsError booloptional
type BetaContainerUploadBlockParamResp struct{…}
type BetaContainerUploadBlockParamResp struct{…}
A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory.
FileID string
Type ContainerUpload
Type ContainerUpload
Accepts one of the following:
const ContainerUploadContainerUpload ContainerUpload = "container_upload"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Role BetaMessageParamRole
Role BetaMessageParamRole
Accepts one of the following:
const BetaMessageParamRoleUser BetaMessageParamRole = "user"
const BetaMessageParamRoleAssistant BetaMessageParamRole = "assistant"
type BetaMessageTokensCount struct{…}
type BetaMessageTokensCount struct{…}
ContextManagement BetaCountTokensContextManagementResponse
ContextManagement BetaCountTokensContextManagementResponse
Information about context management applied to the message.
OriginalInputTokens int64
OriginalInputTokens int64
The original token count before context management was applied
InputTokens int64
InputTokens int64
The total number of tokens across the provided list of messages, system prompt, and tools.
type BetaMetadata struct{…}
type BetaMetadata struct{…}
UserID stringoptional
UserID stringoptional
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
type BetaOutputConfig struct{…}
type BetaOutputConfig struct{…}
Effort BetaOutputConfigEffortoptional
Effort BetaOutputConfigEffortoptional
All possible effort levels.
Accepts one of the following:
const BetaOutputConfigEffortLow BetaOutputConfigEffort = "low"
const BetaOutputConfigEffortMedium BetaOutputConfigEffort = "medium"
const BetaOutputConfigEffortHigh BetaOutputConfigEffort = "high"
type BetaPlainTextSource struct{…}
type BetaPlainTextSource struct{…}
Data string
MediaType TextPlain
MediaType TextPlain
Accepts one of the following:
const TextPlainTextPlain TextPlain = "text/plain"
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
type BetaRawContentBlockDeltaUnion interface{…}
type BetaRawContentBlockDeltaUnion interface{…}
Accepts one of the following:
type BetaTextDelta struct{…}
type BetaTextDelta struct{…}
Text string
Type TextDelta
Type TextDelta
Accepts one of the following:
const TextDeltaTextDelta TextDelta = "text_delta"
type BetaInputJSONDelta struct{…}
type BetaInputJSONDelta struct{…}
PartialJSON string
Type InputJSONDelta
Type InputJSONDelta
Accepts one of the following:
const InputJSONDeltaInputJSONDelta InputJSONDelta = "input_json_delta"
type BetaCitationsDelta struct{…}
type BetaCitationsDelta struct{…}
Citation BetaCitationsDeltaCitationUnion
Citation BetaCitationsDeltaCitationUnion
Accepts one of the following:
type BetaCitationCharLocation struct{…}
type BetaCitationCharLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
FileID string
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Type CitationsDelta
Type CitationsDelta
Accepts one of the following:
const CitationsDeltaCitationsDelta CitationsDelta = "citations_delta"
type BetaThinkingDelta struct{…}
type BetaThinkingDelta struct{…}
Thinking string
Type ThinkingDelta
Type ThinkingDelta
Accepts one of the following:
const ThinkingDeltaThinkingDelta ThinkingDelta = "thinking_delta"
type BetaSignatureDelta struct{…}
type BetaSignatureDelta struct{…}
Signature string
Type SignatureDelta
Type SignatureDelta
Accepts one of the following:
const SignatureDeltaSignatureDelta SignatureDelta = "signature_delta"
type BetaRawContentBlockDeltaEvent struct{…}
type BetaRawContentBlockDeltaEvent struct{…}
Accepts one of the following:
type BetaTextDelta struct{…}
type BetaTextDelta struct{…}
Text string
Type TextDelta
Type TextDelta
Accepts one of the following:
const TextDeltaTextDelta TextDelta = "text_delta"
type BetaInputJSONDelta struct{…}
type BetaInputJSONDelta struct{…}
PartialJSON string
Type InputJSONDelta
Type InputJSONDelta
Accepts one of the following:
const InputJSONDeltaInputJSONDelta InputJSONDelta = "input_json_delta"
type BetaCitationsDelta struct{…}
type BetaCitationsDelta struct{…}
Citation BetaCitationsDeltaCitationUnion
Citation BetaCitationsDeltaCitationUnion
Accepts one of the following:
type BetaCitationCharLocation struct{…}
type BetaCitationCharLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
FileID string
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Type CitationsDelta
Type CitationsDelta
Accepts one of the following:
const CitationsDeltaCitationsDelta CitationsDelta = "citations_delta"
type BetaThinkingDelta struct{…}
type BetaThinkingDelta struct{…}
Thinking string
Type ThinkingDelta
Type ThinkingDelta
Accepts one of the following:
const ThinkingDeltaThinkingDelta ThinkingDelta = "thinking_delta"
type BetaSignatureDelta struct{…}
type BetaSignatureDelta struct{…}
Signature string
Type SignatureDelta
Type SignatureDelta
Accepts one of the following:
const SignatureDeltaSignatureDelta SignatureDelta = "signature_delta"
Index int64
Type ContentBlockDelta
Type ContentBlockDelta
Accepts one of the following:
const ContentBlockDeltaContentBlockDelta ContentBlockDelta = "content_block_delta"
type BetaRawContentBlockStartEvent struct{…}
type BetaRawContentBlockStartEvent struct{…}
ContentBlock BetaRawContentBlockStartEventContentBlockUnion
ContentBlock BetaRawContentBlockStartEventContentBlockUnion
Response model for a file uploaded to the container.
Accepts one of the following:
type BetaTextBlock struct{…}
type BetaTextBlock struct{…}
Citations []BetaTextCitationUnion
Citations []BetaTextCitationUnion
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
Accepts one of the following:
type BetaCitationCharLocation struct{…}
type BetaCitationCharLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
FileID string
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
type BetaThinkingBlock struct{…}
type BetaThinkingBlock struct{…}
Signature string
Thinking string
Type Thinking
Type Thinking
Accepts one of the following:
const ThinkingThinking Thinking = "thinking"
type BetaRedactedThinkingBlock struct{…}
type BetaRedactedThinkingBlock struct{…}
Data string
Type RedactedThinking
Type RedactedThinking
Accepts one of the following:
const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"
type BetaToolUseBlock struct{…}
type BetaToolUseBlock struct{…}
ID string
Input map[string, any]
Name string
Type ToolUse
Type ToolUse
Accepts one of the following:
const ToolUseToolUse ToolUse = "tool_use"
Caller BetaToolUseBlockCallerUnionoptional
Caller BetaToolUseBlockCallerUnionoptional
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
Type Direct
Accepts one of the following:
const DirectDirect Direct = "direct"
type BetaServerToolCaller struct{…}
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
type BetaServerToolUseBlock struct{…}
type BetaServerToolUseBlock struct{…}
ID string
Caller BetaServerToolUseBlockCallerUnion
Caller BetaServerToolUseBlockCallerUnion
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
Type Direct
Accepts one of the following:
const DirectDirect Direct = "direct"
type BetaServerToolCaller struct{…}
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
Input map[string, any]
Name BetaServerToolUseBlockName
Name BetaServerToolUseBlockName
Accepts one of the following:
const BetaServerToolUseBlockNameWebSearch BetaServerToolUseBlockName = "web_search"
const BetaServerToolUseBlockNameWebFetch BetaServerToolUseBlockName = "web_fetch"
const BetaServerToolUseBlockNameCodeExecution BetaServerToolUseBlockName = "code_execution"
const BetaServerToolUseBlockNameBashCodeExecution BetaServerToolUseBlockName = "bash_code_execution"
const BetaServerToolUseBlockNameTextEditorCodeExecution BetaServerToolUseBlockName = "text_editor_code_execution"
const BetaServerToolUseBlockNameToolSearchToolRegex BetaServerToolUseBlockName = "tool_search_tool_regex"
const BetaServerToolUseBlockNameToolSearchToolBm25 BetaServerToolUseBlockName = "tool_search_tool_bm25"
Type ServerToolUse
Type ServerToolUse
Accepts one of the following:
const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"
type BetaWebSearchToolResultBlock struct{…}
type BetaWebSearchToolResultBlock struct{…}
Accepts one of the following:
type BetaWebSearchToolResultError struct{…}
type BetaWebSearchToolResultError struct{…}
ErrorCode BetaWebSearchToolResultErrorCode
ErrorCode BetaWebSearchToolResultErrorCode
Accepts one of the following:
const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"
const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"
const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"
const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"
Type WebSearchToolResultError
Type WebSearchToolResultError
Accepts one of the following:
const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"
EncryptedContent string
PageAge string
Title string
Type WebSearchResult
Type WebSearchResult
Accepts one of the following:
const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"
URL string
ToolUseID string
Type WebSearchToolResult
Type WebSearchToolResult
Accepts one of the following:
const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"
type BetaWebFetchToolResultBlock struct{…}
type BetaWebFetchToolResultBlock struct{…}
Content BetaWebFetchToolResultBlockContentUnion
Content BetaWebFetchToolResultBlockContentUnion
Accepts one of the following:
type BetaWebFetchToolResultErrorBlock struct{…}
type BetaWebFetchToolResultErrorBlock struct{…}
ErrorCode BetaWebFetchToolResultErrorCode
ErrorCode BetaWebFetchToolResultErrorCode
Accepts one of the following:
const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"
const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"
const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"
const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"
const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"
const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"
Type WebFetchToolResultError
Type WebFetchToolResultError
Accepts one of the following:
const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"
type BetaWebFetchBlock struct{…}
type BetaWebFetchBlock struct{…}
Content BetaDocumentBlock
Content BetaDocumentBlock
Citations BetaCitationConfig
Citations BetaCitationConfig
Citation configuration for the document
Enabled bool
Source BetaDocumentBlockSourceUnion
Source BetaDocumentBlockSourceUnion
Accepts one of the following:
type BetaBase64PDFSource struct{…}
type BetaBase64PDFSource struct{…}
Data string
MediaType ApplicationPDF
MediaType ApplicationPDF
Accepts one of the following:
const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaPlainTextSource struct{…}
type BetaPlainTextSource struct{…}
Data string
MediaType TextPlain
MediaType TextPlain
Accepts one of the following:
const TextPlainTextPlain TextPlain = "text/plain"
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Title string
Title string
The title of the document
Type Document
Type Document
Accepts one of the following:
const DocumentDocument Document = "document"
RetrievedAt string
RetrievedAt string
ISO 8601 timestamp when the content was retrieved
Type WebFetchResult
Type WebFetchResult
Accepts one of the following:
const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"
URL string
URL string
Fetched content URL
ToolUseID string
Type WebFetchToolResult
Type WebFetchToolResult
Accepts one of the following:
const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"
type BetaCodeExecutionToolResultBlock struct{…}
type BetaCodeExecutionToolResultBlock struct{…}
Accepts one of the following:
type BetaCodeExecutionToolResultError struct{…}
type BetaCodeExecutionToolResultError struct{…}
ErrorCode BetaCodeExecutionToolResultErrorCode
ErrorCode BetaCodeExecutionToolResultErrorCode
Accepts one of the following:
const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"
const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"
const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"
const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"
Type CodeExecutionToolResultError
Type CodeExecutionToolResultError
Accepts one of the following:
const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"
type BetaCodeExecutionResultBlock struct{…}
type BetaCodeExecutionResultBlock struct{…}
Content []BetaCodeExecutionOutputBlock
Content []BetaCodeExecutionOutputBlock
FileID string
Type CodeExecutionOutput
Type CodeExecutionOutput
Accepts one of the following:
const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type CodeExecutionResult
Type CodeExecutionResult
Accepts one of the following:
const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"
ToolUseID string
Type CodeExecutionToolResult
Type CodeExecutionToolResult
Accepts one of the following:
const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"
type BetaBashCodeExecutionToolResultBlock struct{…}
type BetaBashCodeExecutionToolResultBlock struct{…}
Content BetaBashCodeExecutionToolResultBlockContentUnion
Content BetaBashCodeExecutionToolResultBlockContentUnion
Accepts one of the following:
type BetaBashCodeExecutionToolResultError struct{…}
type BetaBashCodeExecutionToolResultError struct{…}
ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode
ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode
Accepts one of the following:
const BetaBashCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"
const BetaBashCodeExecutionToolResultErrorErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorErrorCode = "unavailable"
const BetaBashCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorErrorCode = "too_many_requests"
const BetaBashCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"
const BetaBashCodeExecutionToolResultErrorErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorErrorCode = "output_file_too_large"
Type BashCodeExecutionToolResultError
Type BashCodeExecutionToolResultError
Accepts one of the following:
const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"
type BetaBashCodeExecutionResultBlock struct{…}
type BetaBashCodeExecutionResultBlock struct{…}
Content []BetaBashCodeExecutionOutputBlock
Content []BetaBashCodeExecutionOutputBlock
FileID string
Type BashCodeExecutionOutput
Type BashCodeExecutionOutput
Accepts one of the following:
const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type BashCodeExecutionResult
Type BashCodeExecutionResult
Accepts one of the following:
const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"
ToolUseID string
Type BashCodeExecutionToolResult
Type BashCodeExecutionToolResult
Accepts one of the following:
const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"
type BetaTextEditorCodeExecutionToolResultBlock struct{…}
type BetaTextEditorCodeExecutionToolResultBlock struct{…}
Content BetaTextEditorCodeExecutionToolResultBlockContentUnion
Content BetaTextEditorCodeExecutionToolResultBlockContentUnion
Accepts one of the following:
type BetaTextEditorCodeExecutionToolResultError struct{…}
type BetaTextEditorCodeExecutionToolResultError struct{…}
ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode
ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode
Accepts one of the following:
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorErrorCode = "unavailable"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorErrorCode = "too_many_requests"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorErrorCode = "file_not_found"
ErrorMessage string
Type TextEditorCodeExecutionToolResultError
Type TextEditorCodeExecutionToolResultError
Accepts one of the following:
const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"
type BetaTextEditorCodeExecutionViewResultBlock struct{…}
type BetaTextEditorCodeExecutionViewResultBlock struct{…}
Content string
FileType BetaTextEditorCodeExecutionViewResultBlockFileType
FileType BetaTextEditorCodeExecutionViewResultBlockFileType
Accepts one of the following:
const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"
const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"
const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"
NumLines int64
StartLine int64
TotalLines int64
Type TextEditorCodeExecutionViewResult
Type TextEditorCodeExecutionViewResult
Accepts one of the following:
const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"
type BetaTextEditorCodeExecutionCreateResultBlock struct{…}
type BetaTextEditorCodeExecutionCreateResultBlock struct{…}
IsFileUpdate bool
Type TextEditorCodeExecutionCreateResult
Type TextEditorCodeExecutionCreateResult
Accepts one of the following:
const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"
type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}
type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}
Lines []string
NewLines int64
NewStart int64
OldLines int64
OldStart int64
Type TextEditorCodeExecutionStrReplaceResult
Type TextEditorCodeExecutionStrReplaceResult
Accepts one of the following:
const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"
ToolUseID string
Type TextEditorCodeExecutionToolResult
Type TextEditorCodeExecutionToolResult
Accepts one of the following:
const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"
type BetaToolSearchToolResultBlock struct{…}
type BetaToolSearchToolResultBlock struct{…}
Content BetaToolSearchToolResultBlockContentUnion
Content BetaToolSearchToolResultBlockContentUnion
Accepts one of the following:
type BetaToolSearchToolResultError struct{…}
type BetaToolSearchToolResultError struct{…}
ErrorCode BetaToolSearchToolResultErrorErrorCode
ErrorCode BetaToolSearchToolResultErrorErrorCode
Accepts one of the following:
const BetaToolSearchToolResultErrorErrorCodeInvalidToolInput BetaToolSearchToolResultErrorErrorCode = "invalid_tool_input"
const BetaToolSearchToolResultErrorErrorCodeUnavailable BetaToolSearchToolResultErrorErrorCode = "unavailable"
const BetaToolSearchToolResultErrorErrorCodeTooManyRequests BetaToolSearchToolResultErrorErrorCode = "too_many_requests"
const BetaToolSearchToolResultErrorErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorErrorCode = "execution_time_exceeded"
ErrorMessage string
Type ToolSearchToolResultError
Type ToolSearchToolResultError
Accepts one of the following:
const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"
type BetaToolSearchToolSearchResultBlock struct{…}
type BetaToolSearchToolSearchResultBlock struct{…}
ToolReferences []BetaToolReferenceBlock
ToolReferences []BetaToolReferenceBlock
ToolName string
Type ToolReference
Type ToolReference
Accepts one of the following:
const ToolReferenceToolReference ToolReference = "tool_reference"
Type ToolSearchToolSearchResult
Type ToolSearchToolSearchResult
Accepts one of the following:
const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"
ToolUseID string
Type ToolSearchToolResult
Type ToolSearchToolResult
Accepts one of the following:
const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"
type BetaMCPToolUseBlock struct{…}
type BetaMCPToolUseBlock struct{…}
ID string
Input map[string, any]
Name string
Name string
The name of the MCP tool
ServerName string
ServerName string
The name of the MCP server
Type MCPToolUse
Type MCPToolUse
Accepts one of the following:
const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"
type BetaMCPToolResultBlock struct{…}
type BetaMCPToolResultBlock struct{…}
Content BetaMCPToolResultBlockContentUnion
Content BetaMCPToolResultBlockContentUnion
Accepts one of the following:
string
Citations []BetaTextCitationUnion
Citations []BetaTextCitationUnion
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
Accepts one of the following:
type BetaCitationCharLocation struct{…}
type BetaCitationCharLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
FileID string
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
IsError bool
ToolUseID string
Type MCPToolResult
Type MCPToolResult
Accepts one of the following:
const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"
type BetaContainerUploadBlock struct{…}
type BetaContainerUploadBlock struct{…}
Response model for a file uploaded to the container.
FileID string
Type ContainerUpload
Type ContainerUpload
Accepts one of the following:
const ContainerUploadContainerUpload ContainerUpload = "container_upload"
Index int64
Type ContentBlockStart
Type ContentBlockStart
Accepts one of the following:
const ContentBlockStartContentBlockStart ContentBlockStart = "content_block_start"
type BetaRawContentBlockStopEvent struct{…}
type BetaRawContentBlockStopEvent struct{…}
Index int64
Type ContentBlockStop
Type ContentBlockStop
Accepts one of the following:
const ContentBlockStopContentBlockStop ContentBlockStop = "content_block_stop"
type BetaRawMessageDeltaEvent struct{…}
type BetaRawMessageDeltaEvent struct{…}
ContextManagement BetaContextManagementResponse
ContextManagement BetaContextManagementResponse
Information about context management strategies applied during the request
AppliedEdits []BetaContextManagementResponseAppliedEditUnion
AppliedEdits []BetaContextManagementResponseAppliedEditUnion
List of context management edits that were applied.
Accepts one of the following:
type BetaClearToolUses20250919EditResponse struct{…}
type BetaClearToolUses20250919EditResponse struct{…}
ClearedInputTokens int64
ClearedInputTokens int64
Number of input tokens cleared by this edit.
minimum0
ClearedToolUses int64
ClearedToolUses int64
Number of tool uses that were cleared.
minimum0
Type ClearToolUses20250919
Type ClearToolUses20250919
The type of context management edit applied.
Accepts one of the following:
const ClearToolUses20250919ClearToolUses20250919 ClearToolUses20250919 = "clear_tool_uses_20250919"
type BetaClearThinking20251015EditResponse struct{…}
type BetaClearThinking20251015EditResponse struct{…}
ClearedInputTokens int64
ClearedInputTokens int64
Number of input tokens cleared by this edit.
minimum0
ClearedThinkingTurns int64
ClearedThinkingTurns int64
Number of thinking turns that were cleared.
minimum0
Type ClearThinking20251015
Type ClearThinking20251015
The type of context management edit applied.
Accepts one of the following:
const ClearThinking20251015ClearThinking20251015 ClearThinking20251015 = "clear_thinking_20251015"
Delta BetaRawMessageDeltaEventDelta
Delta BetaRawMessageDeltaEventDelta
Container BetaContainer
Container BetaContainer
Information about the container used in the request (for the code execution tool)
ID string
ID string
Identifier for the container used in this request
ExpiresAt Time
ExpiresAt Time
The time at which the container will expire.
formatdate-time
Skills []BetaSkill
Skills []BetaSkill
Skills loaded in the container
SkillID string
SkillID string
Skill ID
maxLength64
minLength1
Type BetaSkillType
Type BetaSkillType
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Accepts one of the following:
const BetaSkillTypeAnthropic BetaSkillType = "anthropic"
const BetaSkillTypeCustom BetaSkillType = "custom"
Version string
Version string
Skill version or 'latest' for most recent version
maxLength64
minLength1
StopReason BetaStopReason
StopReason BetaStopReason
Accepts one of the following:
StopSequence string
Type MessageDelta
Type MessageDelta
Accepts one of the following:
const MessageDeltaMessageDelta MessageDelta = "message_delta"
Usage BetaMessageDeltaUsage
Usage BetaMessageDeltaUsage
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
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.
CacheCreationInputTokens int64
CacheCreationInputTokens int64
The cumulative number of input tokens used to create the cache entry.
minimum0
CacheReadInputTokens int64
CacheReadInputTokens int64
The cumulative number of input tokens read from the cache.
minimum0
InputTokens int64
InputTokens int64
The cumulative number of input tokens which were used.
minimum0
OutputTokens int64
OutputTokens int64
The cumulative number of output tokens which were used.
ServerToolUse BetaServerToolUsage
ServerToolUse BetaServerToolUsage
The number of server tool requests.
WebFetchRequests int64
WebFetchRequests int64
The number of web fetch tool requests.
minimum0
WebSearchRequests int64
WebSearchRequests int64
The number of web search tool requests.
minimum0
type BetaRawMessageStartEvent struct{…}
type BetaRawMessageStartEvent struct{…}
Message BetaMessage
Message BetaMessage
ID string
ID string
Unique object identifier.
The format and length of IDs may change over time.
Container BetaContainer
Container BetaContainer
Information about the container used in the request (for the code execution tool)
ID string
ID string
Identifier for the container used in this request
ExpiresAt Time
ExpiresAt Time
The time at which the container will expire.
formatdate-time
Skills []BetaSkill
Skills []BetaSkill
Skills loaded in the container
SkillID string
SkillID string
Skill ID
maxLength64
minLength1
Type BetaSkillType
Type BetaSkillType
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Accepts one of the following:
const BetaSkillTypeAnthropic BetaSkillType = "anthropic"
const BetaSkillTypeCustom BetaSkillType = "custom"
Version string
Version string
Skill version or 'latest' for most recent version
maxLength64
minLength1
Content []BetaContentBlockUnion
Content []BetaContentBlockUnion
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:
type BetaTextBlock struct{…}
type BetaTextBlock struct{…}
Citations []BetaTextCitationUnion
Citations []BetaTextCitationUnion
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
Accepts one of the following:
type BetaCitationCharLocation struct{…}
type BetaCitationCharLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
FileID string
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
type BetaThinkingBlock struct{…}
type BetaThinkingBlock struct{…}
Signature string
Thinking string
Type Thinking
Type Thinking
Accepts one of the following:
const ThinkingThinking Thinking = "thinking"
type BetaRedactedThinkingBlock struct{…}
type BetaRedactedThinkingBlock struct{…}
Data string
Type RedactedThinking
Type RedactedThinking
Accepts one of the following:
const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"
type BetaToolUseBlock struct{…}
type BetaToolUseBlock struct{…}
ID string
Input map[string, any]
Name string
Type ToolUse
Type ToolUse
Accepts one of the following:
const ToolUseToolUse ToolUse = "tool_use"
Caller BetaToolUseBlockCallerUnionoptional
Caller BetaToolUseBlockCallerUnionoptional
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
Type Direct
Accepts one of the following:
const DirectDirect Direct = "direct"
type BetaServerToolCaller struct{…}
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
type BetaServerToolUseBlock struct{…}
type BetaServerToolUseBlock struct{…}
ID string
Caller BetaServerToolUseBlockCallerUnion
Caller BetaServerToolUseBlockCallerUnion
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
Type Direct
Accepts one of the following:
const DirectDirect Direct = "direct"
type BetaServerToolCaller struct{…}
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
Input map[string, any]
Name BetaServerToolUseBlockName
Name BetaServerToolUseBlockName
Accepts one of the following:
const BetaServerToolUseBlockNameWebSearch BetaServerToolUseBlockName = "web_search"
const BetaServerToolUseBlockNameWebFetch BetaServerToolUseBlockName = "web_fetch"
const BetaServerToolUseBlockNameCodeExecution BetaServerToolUseBlockName = "code_execution"
const BetaServerToolUseBlockNameBashCodeExecution BetaServerToolUseBlockName = "bash_code_execution"
const BetaServerToolUseBlockNameTextEditorCodeExecution BetaServerToolUseBlockName = "text_editor_code_execution"
const BetaServerToolUseBlockNameToolSearchToolRegex BetaServerToolUseBlockName = "tool_search_tool_regex"
const BetaServerToolUseBlockNameToolSearchToolBm25 BetaServerToolUseBlockName = "tool_search_tool_bm25"
Type ServerToolUse
Type ServerToolUse
Accepts one of the following:
const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"
type BetaWebSearchToolResultBlock struct{…}
type BetaWebSearchToolResultBlock struct{…}
Accepts one of the following:
type BetaWebSearchToolResultError struct{…}
type BetaWebSearchToolResultError struct{…}
ErrorCode BetaWebSearchToolResultErrorCode
ErrorCode BetaWebSearchToolResultErrorCode
Accepts one of the following:
const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"
const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"
const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"
const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"
Type WebSearchToolResultError
Type WebSearchToolResultError
Accepts one of the following:
const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"
EncryptedContent string
PageAge string
Title string
Type WebSearchResult
Type WebSearchResult
Accepts one of the following:
const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"
URL string
ToolUseID string
Type WebSearchToolResult
Type WebSearchToolResult
Accepts one of the following:
const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"
type BetaWebFetchToolResultBlock struct{…}
type BetaWebFetchToolResultBlock struct{…}
Content BetaWebFetchToolResultBlockContentUnion
Content BetaWebFetchToolResultBlockContentUnion
Accepts one of the following:
type BetaWebFetchToolResultErrorBlock struct{…}
type BetaWebFetchToolResultErrorBlock struct{…}
ErrorCode BetaWebFetchToolResultErrorCode
ErrorCode BetaWebFetchToolResultErrorCode
Accepts one of the following:
const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"
const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"
const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"
const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"
const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"
const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"
Type WebFetchToolResultError
Type WebFetchToolResultError
Accepts one of the following:
const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"
type BetaWebFetchBlock struct{…}
type BetaWebFetchBlock struct{…}
Content BetaDocumentBlock
Content BetaDocumentBlock
Citations BetaCitationConfig
Citations BetaCitationConfig
Citation configuration for the document
Enabled bool
Source BetaDocumentBlockSourceUnion
Source BetaDocumentBlockSourceUnion
Accepts one of the following:
type BetaBase64PDFSource struct{…}
type BetaBase64PDFSource struct{…}
Data string
MediaType ApplicationPDF
MediaType ApplicationPDF
Accepts one of the following:
const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaPlainTextSource struct{…}
type BetaPlainTextSource struct{…}
Data string
MediaType TextPlain
MediaType TextPlain
Accepts one of the following:
const TextPlainTextPlain TextPlain = "text/plain"
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Title string
Title string
The title of the document
Type Document
Type Document
Accepts one of the following:
const DocumentDocument Document = "document"
RetrievedAt string
RetrievedAt string
ISO 8601 timestamp when the content was retrieved
Type WebFetchResult
Type WebFetchResult
Accepts one of the following:
const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"
URL string
URL string
Fetched content URL
ToolUseID string
Type WebFetchToolResult
Type WebFetchToolResult
Accepts one of the following:
const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"
type BetaCodeExecutionToolResultBlock struct{…}
type BetaCodeExecutionToolResultBlock struct{…}
Accepts one of the following:
type BetaCodeExecutionToolResultError struct{…}
type BetaCodeExecutionToolResultError struct{…}
ErrorCode BetaCodeExecutionToolResultErrorCode
ErrorCode BetaCodeExecutionToolResultErrorCode
Accepts one of the following:
const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"
const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"
const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"
const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"
Type CodeExecutionToolResultError
Type CodeExecutionToolResultError
Accepts one of the following:
const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"
type BetaCodeExecutionResultBlock struct{…}
type BetaCodeExecutionResultBlock struct{…}
Content []BetaCodeExecutionOutputBlock
Content []BetaCodeExecutionOutputBlock
FileID string
Type CodeExecutionOutput
Type CodeExecutionOutput
Accepts one of the following:
const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type CodeExecutionResult
Type CodeExecutionResult
Accepts one of the following:
const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"
ToolUseID string
Type CodeExecutionToolResult
Type CodeExecutionToolResult
Accepts one of the following:
const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"
type BetaBashCodeExecutionToolResultBlock struct{…}
type BetaBashCodeExecutionToolResultBlock struct{…}
Content BetaBashCodeExecutionToolResultBlockContentUnion
Content BetaBashCodeExecutionToolResultBlockContentUnion
Accepts one of the following:
type BetaBashCodeExecutionToolResultError struct{…}
type BetaBashCodeExecutionToolResultError struct{…}
ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode
ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode
Accepts one of the following:
const BetaBashCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"
const BetaBashCodeExecutionToolResultErrorErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorErrorCode = "unavailable"
const BetaBashCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorErrorCode = "too_many_requests"
const BetaBashCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"
const BetaBashCodeExecutionToolResultErrorErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorErrorCode = "output_file_too_large"
Type BashCodeExecutionToolResultError
Type BashCodeExecutionToolResultError
Accepts one of the following:
const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"
type BetaBashCodeExecutionResultBlock struct{…}
type BetaBashCodeExecutionResultBlock struct{…}
Content []BetaBashCodeExecutionOutputBlock
Content []BetaBashCodeExecutionOutputBlock
FileID string
Type BashCodeExecutionOutput
Type BashCodeExecutionOutput
Accepts one of the following:
const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type BashCodeExecutionResult
Type BashCodeExecutionResult
Accepts one of the following:
const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"
ToolUseID string
Type BashCodeExecutionToolResult
Type BashCodeExecutionToolResult
Accepts one of the following:
const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"
type BetaTextEditorCodeExecutionToolResultBlock struct{…}
type BetaTextEditorCodeExecutionToolResultBlock struct{…}
Content BetaTextEditorCodeExecutionToolResultBlockContentUnion
Content BetaTextEditorCodeExecutionToolResultBlockContentUnion
Accepts one of the following:
type BetaTextEditorCodeExecutionToolResultError struct{…}
type BetaTextEditorCodeExecutionToolResultError struct{…}
ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode
ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode
Accepts one of the following:
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorErrorCode = "unavailable"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorErrorCode = "too_many_requests"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorErrorCode = "file_not_found"
ErrorMessage string
Type TextEditorCodeExecutionToolResultError
Type TextEditorCodeExecutionToolResultError
Accepts one of the following:
const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"
type BetaTextEditorCodeExecutionViewResultBlock struct{…}
type BetaTextEditorCodeExecutionViewResultBlock struct{…}
Content string
FileType BetaTextEditorCodeExecutionViewResultBlockFileType
FileType BetaTextEditorCodeExecutionViewResultBlockFileType
Accepts one of the following:
const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"
const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"
const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"
NumLines int64
StartLine int64
TotalLines int64
Type TextEditorCodeExecutionViewResult
Type TextEditorCodeExecutionViewResult
Accepts one of the following:
const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"
type BetaTextEditorCodeExecutionCreateResultBlock struct{…}
type BetaTextEditorCodeExecutionCreateResultBlock struct{…}
IsFileUpdate bool
Type TextEditorCodeExecutionCreateResult
Type TextEditorCodeExecutionCreateResult
Accepts one of the following:
const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"
type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}
type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}
Lines []string
NewLines int64
NewStart int64
OldLines int64
OldStart int64
Type TextEditorCodeExecutionStrReplaceResult
Type TextEditorCodeExecutionStrReplaceResult
Accepts one of the following:
const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"
ToolUseID string
Type TextEditorCodeExecutionToolResult
Type TextEditorCodeExecutionToolResult
Accepts one of the following:
const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"
type BetaToolSearchToolResultBlock struct{…}
type BetaToolSearchToolResultBlock struct{…}
Content BetaToolSearchToolResultBlockContentUnion
Content BetaToolSearchToolResultBlockContentUnion
Accepts one of the following:
type BetaToolSearchToolResultError struct{…}
type BetaToolSearchToolResultError struct{…}
ErrorCode BetaToolSearchToolResultErrorErrorCode
ErrorCode BetaToolSearchToolResultErrorErrorCode
Accepts one of the following:
const BetaToolSearchToolResultErrorErrorCodeInvalidToolInput BetaToolSearchToolResultErrorErrorCode = "invalid_tool_input"
const BetaToolSearchToolResultErrorErrorCodeUnavailable BetaToolSearchToolResultErrorErrorCode = "unavailable"
const BetaToolSearchToolResultErrorErrorCodeTooManyRequests BetaToolSearchToolResultErrorErrorCode = "too_many_requests"
const BetaToolSearchToolResultErrorErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorErrorCode = "execution_time_exceeded"
ErrorMessage string
Type ToolSearchToolResultError
Type ToolSearchToolResultError
Accepts one of the following:
const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"
type BetaToolSearchToolSearchResultBlock struct{…}
type BetaToolSearchToolSearchResultBlock struct{…}
ToolReferences []BetaToolReferenceBlock
ToolReferences []BetaToolReferenceBlock
ToolName string
Type ToolReference
Type ToolReference
Accepts one of the following:
const ToolReferenceToolReference ToolReference = "tool_reference"
Type ToolSearchToolSearchResult
Type ToolSearchToolSearchResult
Accepts one of the following:
const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"
ToolUseID string
Type ToolSearchToolResult
Type ToolSearchToolResult
Accepts one of the following:
const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"
type BetaMCPToolUseBlock struct{…}
type BetaMCPToolUseBlock struct{…}
ID string
Input map[string, any]
Name string
Name string
The name of the MCP tool
ServerName string
ServerName string
The name of the MCP server
Type MCPToolUse
Type MCPToolUse
Accepts one of the following:
const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"
type BetaMCPToolResultBlock struct{…}
type BetaMCPToolResultBlock struct{…}
Content BetaMCPToolResultBlockContentUnion
Content BetaMCPToolResultBlockContentUnion
Accepts one of the following:
string
Citations []BetaTextCitationUnion
Citations []BetaTextCitationUnion
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
Accepts one of the following:
type BetaCitationCharLocation struct{…}
type BetaCitationCharLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
FileID string
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
IsError bool
ToolUseID string
Type MCPToolResult
Type MCPToolResult
Accepts one of the following:
const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"
type BetaContainerUploadBlock struct{…}
type BetaContainerUploadBlock struct{…}
Response model for a file uploaded to the container.
FileID string
Type ContainerUpload
Type ContainerUpload
Accepts one of the following:
const ContainerUploadContainerUpload ContainerUpload = "container_upload"
ContextManagement BetaContextManagementResponse
ContextManagement BetaContextManagementResponse
Context management response.
Information about context management strategies applied during the request.
AppliedEdits []BetaContextManagementResponseAppliedEditUnion
AppliedEdits []BetaContextManagementResponseAppliedEditUnion
List of context management edits that were applied.
Accepts one of the following:
type BetaClearToolUses20250919EditResponse struct{…}
type BetaClearToolUses20250919EditResponse struct{…}
ClearedInputTokens int64
ClearedInputTokens int64
Number of input tokens cleared by this edit.
minimum0
ClearedToolUses int64
ClearedToolUses int64
Number of tool uses that were cleared.
minimum0
Type ClearToolUses20250919
Type ClearToolUses20250919
The type of context management edit applied.
Accepts one of the following:
const ClearToolUses20250919ClearToolUses20250919 ClearToolUses20250919 = "clear_tool_uses_20250919"
type BetaClearThinking20251015EditResponse struct{…}
type BetaClearThinking20251015EditResponse struct{…}
ClearedInputTokens int64
ClearedInputTokens int64
Number of input tokens cleared by this edit.
minimum0
ClearedThinkingTurns int64
ClearedThinkingTurns int64
Number of thinking turns that were cleared.
minimum0
Type ClearThinking20251015
Type ClearThinking20251015
The type of context management edit applied.
Accepts one of the following:
const ClearThinking20251015ClearThinking20251015 ClearThinking20251015 = "clear_thinking_20251015"
Model Model
Model Model
The model that will complete your prompt.
See models for additional details and options.
Accepts one of the following:
type Model string
type Model string
The model that will complete your prompt.
See models for additional details and options.
Accepts one of the following:
const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"
const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"
Premium model combining maximum intelligence with practical performance
const ModelClaudeOpus4_5 Model = "claude-opus-4-5"
const ModelClaudeOpus4_5 Model = "claude-opus-4-5"
Premium model combining maximum intelligence with practical performance
const ModelClaude3_7SonnetLatest Model = "claude-3-7-sonnet-latest"
const ModelClaude3_7SonnetLatest Model = "claude-3-7-sonnet-latest"
High-performance model with early extended thinking
const ModelClaude3_7Sonnet20250219 Model = "claude-3-7-sonnet-20250219"
const ModelClaude3_7Sonnet20250219 Model = "claude-3-7-sonnet-20250219"
High-performance model with early extended thinking
const ModelClaude3_5HaikuLatest Model = "claude-3-5-haiku-latest"
const ModelClaude3_5HaikuLatest Model = "claude-3-5-haiku-latest"
Fastest and most compact model for near-instant responsiveness
const ModelClaude3_5Haiku20241022 Model = "claude-3-5-haiku-20241022"
const ModelClaude3_5Haiku20241022 Model = "claude-3-5-haiku-20241022"
Our fastest model
const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"
const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"
Hybrid model, capable of near-instant responses and extended thinking
const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"
const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"
Hybrid model, capable of near-instant responses and extended thinking
const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"
const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"
High-performance model with extended thinking
const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"
const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"
High-performance model with extended thinking
const ModelClaude4Sonnet20250514 Model = "claude-4-sonnet-20250514"
const ModelClaude4Sonnet20250514 Model = "claude-4-sonnet-20250514"
High-performance model with extended thinking
const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"
const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"
Our best model for real-world agents and coding
const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"
const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"
Our best model for real-world agents and coding
const ModelClaudeOpus4_0 Model = "claude-opus-4-0"
const ModelClaudeOpus4_0 Model = "claude-opus-4-0"
Our most capable model
const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"
const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"
Our most capable model
const ModelClaude4Opus20250514 Model = "claude-4-opus-20250514"
const ModelClaude4Opus20250514 Model = "claude-4-opus-20250514"
Our most capable model
const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"
const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"
Our most capable model
const ModelClaude3OpusLatest Model = "claude-3-opus-latest"
const ModelClaude3OpusLatest Model = "claude-3-opus-latest"
Excels at writing and complex tasks
const ModelClaude_3_Opus_20240229 Model = "claude-3-opus-20240229"
const ModelClaude_3_Opus_20240229 Model = "claude-3-opus-20240229"
Excels at writing and complex tasks
const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"
const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"
Our previous most fast and cost-effective
string
Role Assistant
Role Assistant
Conversational role of the generated message.
This will always be "assistant".
Accepts one of the following:
const AssistantAssistant Assistant = "assistant"
StopReason BetaStopReason
StopReason BetaStopReason
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
Accepts one of the following:
StopSequence string
StopSequence 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 Message
Type Message
Object type.
For Messages, this is always "message".
Accepts one of the following:
const MessageMessage Message = "message"
Usage BetaUsage
Usage BetaUsage
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
CacheCreation BetaCacheCreation
CacheCreation BetaCacheCreation
Breakdown of cached tokens by TTL
Ephemeral1hInputTokens int64
Ephemeral1hInputTokens int64
The number of input tokens used to create the 1 hour cache entry.
minimum0
Ephemeral5mInputTokens int64
Ephemeral5mInputTokens int64
The number of input tokens used to create the 5 minute cache entry.
minimum0
CacheCreationInputTokens int64
CacheCreationInputTokens int64
The number of input tokens used to create the cache entry.
minimum0
CacheReadInputTokens int64
CacheReadInputTokens int64
The number of input tokens read from the cache.
minimum0
InputTokens int64
InputTokens int64
The number of input tokens which were used.
minimum0
OutputTokens int64
OutputTokens int64
The number of output tokens which were used.
minimum0
ServerToolUse BetaServerToolUsage
ServerToolUse BetaServerToolUsage
The number of server tool requests.
WebFetchRequests int64
WebFetchRequests int64
The number of web fetch tool requests.
minimum0
WebSearchRequests int64
WebSearchRequests int64
The number of web search tool requests.
minimum0
ServiceTier BetaUsageServiceTier
ServiceTier BetaUsageServiceTier
If the request used the priority, standard, or batch tier.
Accepts one of the following:
const BetaUsageServiceTierStandard BetaUsageServiceTier = "standard"
const BetaUsageServiceTierPriority BetaUsageServiceTier = "priority"
const BetaUsageServiceTierBatch BetaUsageServiceTier = "batch"
Type MessageStart
Type MessageStart
Accepts one of the following:
const MessageStartMessageStart MessageStart = "message_start"
type BetaRawMessageStopEvent struct{…}
type BetaRawMessageStopEvent struct{…}
Type MessageStop
Type MessageStop
Accepts one of the following:
const MessageStopMessageStop MessageStop = "message_stop"
type BetaRawMessageStreamEventUnion interface{…}
type BetaRawMessageStreamEventUnion interface{…}
Accepts one of the following:
type BetaRawMessageStartEvent struct{…}
type BetaRawMessageStartEvent struct{…}
Message BetaMessage
Message BetaMessage
ID string
ID string
Unique object identifier.
The format and length of IDs may change over time.
Container BetaContainer
Container BetaContainer
Information about the container used in the request (for the code execution tool)
ID string
ID string
Identifier for the container used in this request
ExpiresAt Time
ExpiresAt Time
The time at which the container will expire.
formatdate-time
Skills []BetaSkill
Skills []BetaSkill
Skills loaded in the container
SkillID string
SkillID string
Skill ID
maxLength64
minLength1
Type BetaSkillType
Type BetaSkillType
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Accepts one of the following:
const BetaSkillTypeAnthropic BetaSkillType = "anthropic"
const BetaSkillTypeCustom BetaSkillType = "custom"
Version string
Version string
Skill version or 'latest' for most recent version
maxLength64
minLength1
Content []BetaContentBlockUnion
Content []BetaContentBlockUnion
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:
type BetaTextBlock struct{…}
type BetaTextBlock struct{…}
Citations []BetaTextCitationUnion
Citations []BetaTextCitationUnion
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
Accepts one of the following:
type BetaCitationCharLocation struct{…}
type BetaCitationCharLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
FileID string
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
type BetaThinkingBlock struct{…}
type BetaThinkingBlock struct{…}
Signature string
Thinking string
Type Thinking
Type Thinking
Accepts one of the following:
const ThinkingThinking Thinking = "thinking"
type BetaRedactedThinkingBlock struct{…}
type BetaRedactedThinkingBlock struct{…}
Data string
Type RedactedThinking
Type RedactedThinking
Accepts one of the following:
const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"
type BetaToolUseBlock struct{…}
type BetaToolUseBlock struct{…}
ID string
Input map[string, any]
Name string
Type ToolUse
Type ToolUse
Accepts one of the following:
const ToolUseToolUse ToolUse = "tool_use"
Caller BetaToolUseBlockCallerUnionoptional
Caller BetaToolUseBlockCallerUnionoptional
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
Type Direct
Accepts one of the following:
const DirectDirect Direct = "direct"
type BetaServerToolCaller struct{…}
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
type BetaServerToolUseBlock struct{…}
type BetaServerToolUseBlock struct{…}
ID string
Caller BetaServerToolUseBlockCallerUnion
Caller BetaServerToolUseBlockCallerUnion
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
Type Direct
Accepts one of the following:
const DirectDirect Direct = "direct"
type BetaServerToolCaller struct{…}
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
Input map[string, any]
Name BetaServerToolUseBlockName
Name BetaServerToolUseBlockName
Accepts one of the following:
const BetaServerToolUseBlockNameWebSearch BetaServerToolUseBlockName = "web_search"
const BetaServerToolUseBlockNameWebFetch BetaServerToolUseBlockName = "web_fetch"
const BetaServerToolUseBlockNameCodeExecution BetaServerToolUseBlockName = "code_execution"
const BetaServerToolUseBlockNameBashCodeExecution BetaServerToolUseBlockName = "bash_code_execution"
const BetaServerToolUseBlockNameTextEditorCodeExecution BetaServerToolUseBlockName = "text_editor_code_execution"
const BetaServerToolUseBlockNameToolSearchToolRegex BetaServerToolUseBlockName = "tool_search_tool_regex"
const BetaServerToolUseBlockNameToolSearchToolBm25 BetaServerToolUseBlockName = "tool_search_tool_bm25"
Type ServerToolUse
Type ServerToolUse
Accepts one of the following:
const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"
type BetaWebSearchToolResultBlock struct{…}
type BetaWebSearchToolResultBlock struct{…}
Accepts one of the following:
type BetaWebSearchToolResultError struct{…}
type BetaWebSearchToolResultError struct{…}
ErrorCode BetaWebSearchToolResultErrorCode
ErrorCode BetaWebSearchToolResultErrorCode
Accepts one of the following:
const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"
const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"
const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"
const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"
Type WebSearchToolResultError
Type WebSearchToolResultError
Accepts one of the following:
const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"
EncryptedContent string
PageAge string
Title string
Type WebSearchResult
Type WebSearchResult
Accepts one of the following:
const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"
URL string
ToolUseID string
Type WebSearchToolResult
Type WebSearchToolResult
Accepts one of the following:
const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"
type BetaWebFetchToolResultBlock struct{…}
type BetaWebFetchToolResultBlock struct{…}
Content BetaWebFetchToolResultBlockContentUnion
Content BetaWebFetchToolResultBlockContentUnion
Accepts one of the following:
type BetaWebFetchToolResultErrorBlock struct{…}
type BetaWebFetchToolResultErrorBlock struct{…}
ErrorCode BetaWebFetchToolResultErrorCode
ErrorCode BetaWebFetchToolResultErrorCode
Accepts one of the following:
const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"
const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"
const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"
const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"
const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"
const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"
Type WebFetchToolResultError
Type WebFetchToolResultError
Accepts one of the following:
const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"
type BetaWebFetchBlock struct{…}
type BetaWebFetchBlock struct{…}
Content BetaDocumentBlock
Content BetaDocumentBlock
Citations BetaCitationConfig
Citations BetaCitationConfig
Citation configuration for the document
Enabled bool
Source BetaDocumentBlockSourceUnion
Source BetaDocumentBlockSourceUnion
Accepts one of the following:
type BetaBase64PDFSource struct{…}
type BetaBase64PDFSource struct{…}
Data string
MediaType ApplicationPDF
MediaType ApplicationPDF
Accepts one of the following:
const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaPlainTextSource struct{…}
type BetaPlainTextSource struct{…}
Data string
MediaType TextPlain
MediaType TextPlain
Accepts one of the following:
const TextPlainTextPlain TextPlain = "text/plain"
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Title string
Title string
The title of the document
Type Document
Type Document
Accepts one of the following:
const DocumentDocument Document = "document"
RetrievedAt string
RetrievedAt string
ISO 8601 timestamp when the content was retrieved
Type WebFetchResult
Type WebFetchResult
Accepts one of the following:
const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"
URL string
URL string
Fetched content URL
ToolUseID string
Type WebFetchToolResult
Type WebFetchToolResult
Accepts one of the following:
const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"
type BetaCodeExecutionToolResultBlock struct{…}
type BetaCodeExecutionToolResultBlock struct{…}
Accepts one of the following:
type BetaCodeExecutionToolResultError struct{…}
type BetaCodeExecutionToolResultError struct{…}
ErrorCode BetaCodeExecutionToolResultErrorCode
ErrorCode BetaCodeExecutionToolResultErrorCode
Accepts one of the following:
const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"
const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"
const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"
const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"
Type CodeExecutionToolResultError
Type CodeExecutionToolResultError
Accepts one of the following:
const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"
type BetaCodeExecutionResultBlock struct{…}
type BetaCodeExecutionResultBlock struct{…}
Content []BetaCodeExecutionOutputBlock
Content []BetaCodeExecutionOutputBlock
FileID string
Type CodeExecutionOutput
Type CodeExecutionOutput
Accepts one of the following:
const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type CodeExecutionResult
Type CodeExecutionResult
Accepts one of the following:
const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"
ToolUseID string
Type CodeExecutionToolResult
Type CodeExecutionToolResult
Accepts one of the following:
const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"
type BetaBashCodeExecutionToolResultBlock struct{…}
type BetaBashCodeExecutionToolResultBlock struct{…}
Content BetaBashCodeExecutionToolResultBlockContentUnion
Content BetaBashCodeExecutionToolResultBlockContentUnion
Accepts one of the following:
type BetaBashCodeExecutionToolResultError struct{…}
type BetaBashCodeExecutionToolResultError struct{…}
ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode
ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode
Accepts one of the following:
const BetaBashCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"
const BetaBashCodeExecutionToolResultErrorErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorErrorCode = "unavailable"
const BetaBashCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorErrorCode = "too_many_requests"
const BetaBashCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"
const BetaBashCodeExecutionToolResultErrorErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorErrorCode = "output_file_too_large"
Type BashCodeExecutionToolResultError
Type BashCodeExecutionToolResultError
Accepts one of the following:
const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"
type BetaBashCodeExecutionResultBlock struct{…}
type BetaBashCodeExecutionResultBlock struct{…}
Content []BetaBashCodeExecutionOutputBlock
Content []BetaBashCodeExecutionOutputBlock
FileID string
Type BashCodeExecutionOutput
Type BashCodeExecutionOutput
Accepts one of the following:
const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type BashCodeExecutionResult
Type BashCodeExecutionResult
Accepts one of the following:
const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"
ToolUseID string
Type BashCodeExecutionToolResult
Type BashCodeExecutionToolResult
Accepts one of the following:
const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"
type BetaTextEditorCodeExecutionToolResultBlock struct{…}
type BetaTextEditorCodeExecutionToolResultBlock struct{…}
Content BetaTextEditorCodeExecutionToolResultBlockContentUnion
Content BetaTextEditorCodeExecutionToolResultBlockContentUnion
Accepts one of the following:
type BetaTextEditorCodeExecutionToolResultError struct{…}
type BetaTextEditorCodeExecutionToolResultError struct{…}
ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode
ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode
Accepts one of the following:
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorErrorCode = "unavailable"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorErrorCode = "too_many_requests"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorErrorCode = "file_not_found"
ErrorMessage string
Type TextEditorCodeExecutionToolResultError
Type TextEditorCodeExecutionToolResultError
Accepts one of the following:
const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"
type BetaTextEditorCodeExecutionViewResultBlock struct{…}
type BetaTextEditorCodeExecutionViewResultBlock struct{…}
Content string
FileType BetaTextEditorCodeExecutionViewResultBlockFileType
FileType BetaTextEditorCodeExecutionViewResultBlockFileType
Accepts one of the following:
const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"
const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"
const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"
NumLines int64
StartLine int64
TotalLines int64
Type TextEditorCodeExecutionViewResult
Type TextEditorCodeExecutionViewResult
Accepts one of the following:
const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"
type BetaTextEditorCodeExecutionCreateResultBlock struct{…}
type BetaTextEditorCodeExecutionCreateResultBlock struct{…}
IsFileUpdate bool
Type TextEditorCodeExecutionCreateResult
Type TextEditorCodeExecutionCreateResult
Accepts one of the following:
const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"
type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}
type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}
Lines []string
NewLines int64
NewStart int64
OldLines int64
OldStart int64
Type TextEditorCodeExecutionStrReplaceResult
Type TextEditorCodeExecutionStrReplaceResult
Accepts one of the following:
const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"
ToolUseID string
Type TextEditorCodeExecutionToolResult
Type TextEditorCodeExecutionToolResult
Accepts one of the following:
const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"
type BetaToolSearchToolResultBlock struct{…}
type BetaToolSearchToolResultBlock struct{…}
Content BetaToolSearchToolResultBlockContentUnion
Content BetaToolSearchToolResultBlockContentUnion
Accepts one of the following:
type BetaToolSearchToolResultError struct{…}
type BetaToolSearchToolResultError struct{…}
ErrorCode BetaToolSearchToolResultErrorErrorCode
ErrorCode BetaToolSearchToolResultErrorErrorCode
Accepts one of the following:
const BetaToolSearchToolResultErrorErrorCodeInvalidToolInput BetaToolSearchToolResultErrorErrorCode = "invalid_tool_input"
const BetaToolSearchToolResultErrorErrorCodeUnavailable BetaToolSearchToolResultErrorErrorCode = "unavailable"
const BetaToolSearchToolResultErrorErrorCodeTooManyRequests BetaToolSearchToolResultErrorErrorCode = "too_many_requests"
const BetaToolSearchToolResultErrorErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorErrorCode = "execution_time_exceeded"
ErrorMessage string
Type ToolSearchToolResultError
Type ToolSearchToolResultError
Accepts one of the following:
const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"
type BetaToolSearchToolSearchResultBlock struct{…}
type BetaToolSearchToolSearchResultBlock struct{…}
ToolReferences []BetaToolReferenceBlock
ToolReferences []BetaToolReferenceBlock
ToolName string
Type ToolReference
Type ToolReference
Accepts one of the following:
const ToolReferenceToolReference ToolReference = "tool_reference"
Type ToolSearchToolSearchResult
Type ToolSearchToolSearchResult
Accepts one of the following:
const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"
ToolUseID string
Type ToolSearchToolResult
Type ToolSearchToolResult
Accepts one of the following:
const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"
type BetaMCPToolUseBlock struct{…}
type BetaMCPToolUseBlock struct{…}
ID string
Input map[string, any]
Name string
Name string
The name of the MCP tool
ServerName string
ServerName string
The name of the MCP server
Type MCPToolUse
Type MCPToolUse
Accepts one of the following:
const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"
type BetaMCPToolResultBlock struct{…}
type BetaMCPToolResultBlock struct{…}
Content BetaMCPToolResultBlockContentUnion
Content BetaMCPToolResultBlockContentUnion
Accepts one of the following:
string
Citations []BetaTextCitationUnion
Citations []BetaTextCitationUnion
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
Accepts one of the following:
type BetaCitationCharLocation struct{…}
type BetaCitationCharLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
FileID string
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
IsError bool
ToolUseID string
Type MCPToolResult
Type MCPToolResult
Accepts one of the following:
const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"
type BetaContainerUploadBlock struct{…}
type BetaContainerUploadBlock struct{…}
Response model for a file uploaded to the container.
FileID string
Type ContainerUpload
Type ContainerUpload
Accepts one of the following:
const ContainerUploadContainerUpload ContainerUpload = "container_upload"
ContextManagement BetaContextManagementResponse
ContextManagement BetaContextManagementResponse
Context management response.
Information about context management strategies applied during the request.
AppliedEdits []BetaContextManagementResponseAppliedEditUnion
AppliedEdits []BetaContextManagementResponseAppliedEditUnion
List of context management edits that were applied.
Accepts one of the following:
type BetaClearToolUses20250919EditResponse struct{…}
type BetaClearToolUses20250919EditResponse struct{…}
ClearedInputTokens int64
ClearedInputTokens int64
Number of input tokens cleared by this edit.
minimum0
ClearedToolUses int64
ClearedToolUses int64
Number of tool uses that were cleared.
minimum0
Type ClearToolUses20250919
Type ClearToolUses20250919
The type of context management edit applied.
Accepts one of the following:
const ClearToolUses20250919ClearToolUses20250919 ClearToolUses20250919 = "clear_tool_uses_20250919"
type BetaClearThinking20251015EditResponse struct{…}
type BetaClearThinking20251015EditResponse struct{…}
ClearedInputTokens int64
ClearedInputTokens int64
Number of input tokens cleared by this edit.
minimum0
ClearedThinkingTurns int64
ClearedThinkingTurns int64
Number of thinking turns that were cleared.
minimum0
Type ClearThinking20251015
Type ClearThinking20251015
The type of context management edit applied.
Accepts one of the following:
const ClearThinking20251015ClearThinking20251015 ClearThinking20251015 = "clear_thinking_20251015"
Model Model
Model Model
The model that will complete your prompt.
See models for additional details and options.
Accepts one of the following:
type Model string
type Model string
The model that will complete your prompt.
See models for additional details and options.
Accepts one of the following:
const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"
const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"
Premium model combining maximum intelligence with practical performance
const ModelClaudeOpus4_5 Model = "claude-opus-4-5"
const ModelClaudeOpus4_5 Model = "claude-opus-4-5"
Premium model combining maximum intelligence with practical performance
const ModelClaude3_7SonnetLatest Model = "claude-3-7-sonnet-latest"
const ModelClaude3_7SonnetLatest Model = "claude-3-7-sonnet-latest"
High-performance model with early extended thinking
const ModelClaude3_7Sonnet20250219 Model = "claude-3-7-sonnet-20250219"
const ModelClaude3_7Sonnet20250219 Model = "claude-3-7-sonnet-20250219"
High-performance model with early extended thinking
const ModelClaude3_5HaikuLatest Model = "claude-3-5-haiku-latest"
const ModelClaude3_5HaikuLatest Model = "claude-3-5-haiku-latest"
Fastest and most compact model for near-instant responsiveness
const ModelClaude3_5Haiku20241022 Model = "claude-3-5-haiku-20241022"
const ModelClaude3_5Haiku20241022 Model = "claude-3-5-haiku-20241022"
Our fastest model
const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"
const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"
Hybrid model, capable of near-instant responses and extended thinking
const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"
const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"
Hybrid model, capable of near-instant responses and extended thinking
const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"
const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"
High-performance model with extended thinking
const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"
const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"
High-performance model with extended thinking
const ModelClaude4Sonnet20250514 Model = "claude-4-sonnet-20250514"
const ModelClaude4Sonnet20250514 Model = "claude-4-sonnet-20250514"
High-performance model with extended thinking
const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"
const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"
Our best model for real-world agents and coding
const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"
const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"
Our best model for real-world agents and coding
const ModelClaudeOpus4_0 Model = "claude-opus-4-0"
const ModelClaudeOpus4_0 Model = "claude-opus-4-0"
Our most capable model
const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"
const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"
Our most capable model
const ModelClaude4Opus20250514 Model = "claude-4-opus-20250514"
const ModelClaude4Opus20250514 Model = "claude-4-opus-20250514"
Our most capable model
const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"
const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"
Our most capable model
const ModelClaude3OpusLatest Model = "claude-3-opus-latest"
const ModelClaude3OpusLatest Model = "claude-3-opus-latest"
Excels at writing and complex tasks
const ModelClaude_3_Opus_20240229 Model = "claude-3-opus-20240229"
const ModelClaude_3_Opus_20240229 Model = "claude-3-opus-20240229"
Excels at writing and complex tasks
const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"
const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"
Our previous most fast and cost-effective
string
Role Assistant
Role Assistant
Conversational role of the generated message.
This will always be "assistant".
Accepts one of the following:
const AssistantAssistant Assistant = "assistant"
StopReason BetaStopReason
StopReason BetaStopReason
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
Accepts one of the following:
StopSequence string
StopSequence 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 Message
Type Message
Object type.
For Messages, this is always "message".
Accepts one of the following:
const MessageMessage Message = "message"
Usage BetaUsage
Usage BetaUsage
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
CacheCreation BetaCacheCreation
CacheCreation BetaCacheCreation
Breakdown of cached tokens by TTL
Ephemeral1hInputTokens int64
Ephemeral1hInputTokens int64
The number of input tokens used to create the 1 hour cache entry.
minimum0
Ephemeral5mInputTokens int64
Ephemeral5mInputTokens int64
The number of input tokens used to create the 5 minute cache entry.
minimum0
CacheCreationInputTokens int64
CacheCreationInputTokens int64
The number of input tokens used to create the cache entry.
minimum0
CacheReadInputTokens int64
CacheReadInputTokens int64
The number of input tokens read from the cache.
minimum0
InputTokens int64
InputTokens int64
The number of input tokens which were used.
minimum0
OutputTokens int64
OutputTokens int64
The number of output tokens which were used.
minimum0
ServerToolUse BetaServerToolUsage
ServerToolUse BetaServerToolUsage
The number of server tool requests.
WebFetchRequests int64
WebFetchRequests int64
The number of web fetch tool requests.
minimum0
WebSearchRequests int64
WebSearchRequests int64
The number of web search tool requests.
minimum0
ServiceTier BetaUsageServiceTier
ServiceTier BetaUsageServiceTier
If the request used the priority, standard, or batch tier.
Accepts one of the following:
const BetaUsageServiceTierStandard BetaUsageServiceTier = "standard"
const BetaUsageServiceTierPriority BetaUsageServiceTier = "priority"
const BetaUsageServiceTierBatch BetaUsageServiceTier = "batch"
Type MessageStart
Type MessageStart
Accepts one of the following:
const MessageStartMessageStart MessageStart = "message_start"
type BetaRawMessageDeltaEvent struct{…}
type BetaRawMessageDeltaEvent struct{…}
ContextManagement BetaContextManagementResponse
ContextManagement BetaContextManagementResponse
Information about context management strategies applied during the request
AppliedEdits []BetaContextManagementResponseAppliedEditUnion
AppliedEdits []BetaContextManagementResponseAppliedEditUnion
List of context management edits that were applied.
Accepts one of the following:
type BetaClearToolUses20250919EditResponse struct{…}
type BetaClearToolUses20250919EditResponse struct{…}
ClearedInputTokens int64
ClearedInputTokens int64
Number of input tokens cleared by this edit.
minimum0
ClearedToolUses int64
ClearedToolUses int64
Number of tool uses that were cleared.
minimum0
Type ClearToolUses20250919
Type ClearToolUses20250919
The type of context management edit applied.
Accepts one of the following:
const ClearToolUses20250919ClearToolUses20250919 ClearToolUses20250919 = "clear_tool_uses_20250919"
type BetaClearThinking20251015EditResponse struct{…}
type BetaClearThinking20251015EditResponse struct{…}
ClearedInputTokens int64
ClearedInputTokens int64
Number of input tokens cleared by this edit.
minimum0
ClearedThinkingTurns int64
ClearedThinkingTurns int64
Number of thinking turns that were cleared.
minimum0
Type ClearThinking20251015
Type ClearThinking20251015
The type of context management edit applied.
Accepts one of the following:
const ClearThinking20251015ClearThinking20251015 ClearThinking20251015 = "clear_thinking_20251015"
Delta BetaRawMessageDeltaEventDelta
Delta BetaRawMessageDeltaEventDelta
Container BetaContainer
Container BetaContainer
Information about the container used in the request (for the code execution tool)
ID string
ID string
Identifier for the container used in this request
ExpiresAt Time
ExpiresAt Time
The time at which the container will expire.
formatdate-time
Skills []BetaSkill
Skills []BetaSkill
Skills loaded in the container
SkillID string
SkillID string
Skill ID
maxLength64
minLength1
Type BetaSkillType
Type BetaSkillType
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Accepts one of the following:
const BetaSkillTypeAnthropic BetaSkillType = "anthropic"
const BetaSkillTypeCustom BetaSkillType = "custom"
Version string
Version string
Skill version or 'latest' for most recent version
maxLength64
minLength1
StopReason BetaStopReason
StopReason BetaStopReason
Accepts one of the following:
StopSequence string
Type MessageDelta
Type MessageDelta
Accepts one of the following:
const MessageDeltaMessageDelta MessageDelta = "message_delta"
Usage BetaMessageDeltaUsage
Usage BetaMessageDeltaUsage
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
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.
CacheCreationInputTokens int64
CacheCreationInputTokens int64
The cumulative number of input tokens used to create the cache entry.
minimum0
CacheReadInputTokens int64
CacheReadInputTokens int64
The cumulative number of input tokens read from the cache.
minimum0
InputTokens int64
InputTokens int64
The cumulative number of input tokens which were used.
minimum0
OutputTokens int64
OutputTokens int64
The cumulative number of output tokens which were used.
ServerToolUse BetaServerToolUsage
ServerToolUse BetaServerToolUsage
The number of server tool requests.
WebFetchRequests int64
WebFetchRequests int64
The number of web fetch tool requests.
minimum0
WebSearchRequests int64
WebSearchRequests int64
The number of web search tool requests.
minimum0
type BetaRawMessageStopEvent struct{…}
type BetaRawMessageStopEvent struct{…}
Type MessageStop
Type MessageStop
Accepts one of the following:
const MessageStopMessageStop MessageStop = "message_stop"
type BetaRawContentBlockStartEvent struct{…}
type BetaRawContentBlockStartEvent struct{…}
ContentBlock BetaRawContentBlockStartEventContentBlockUnion
ContentBlock BetaRawContentBlockStartEventContentBlockUnion
Response model for a file uploaded to the container.
Accepts one of the following:
type BetaTextBlock struct{…}
type BetaTextBlock struct{…}
Citations []BetaTextCitationUnion
Citations []BetaTextCitationUnion
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
Accepts one of the following:
type BetaCitationCharLocation struct{…}
type BetaCitationCharLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
FileID string
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
type BetaThinkingBlock struct{…}
type BetaThinkingBlock struct{…}
Signature string
Thinking string
Type Thinking
Type Thinking
Accepts one of the following:
const ThinkingThinking Thinking = "thinking"
type BetaRedactedThinkingBlock struct{…}
type BetaRedactedThinkingBlock struct{…}
Data string
Type RedactedThinking
Type RedactedThinking
Accepts one of the following:
const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"
type BetaToolUseBlock struct{…}
type BetaToolUseBlock struct{…}
ID string
Input map[string, any]
Name string
Type ToolUse
Type ToolUse
Accepts one of the following:
const ToolUseToolUse ToolUse = "tool_use"
Caller BetaToolUseBlockCallerUnionoptional
Caller BetaToolUseBlockCallerUnionoptional
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
Type Direct
Accepts one of the following:
const DirectDirect Direct = "direct"
type BetaServerToolCaller struct{…}
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
type BetaServerToolUseBlock struct{…}
type BetaServerToolUseBlock struct{…}
ID string
Caller BetaServerToolUseBlockCallerUnion
Caller BetaServerToolUseBlockCallerUnion
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
Type Direct
Accepts one of the following:
const DirectDirect Direct = "direct"
type BetaServerToolCaller struct{…}
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
Input map[string, any]
Name BetaServerToolUseBlockName
Name BetaServerToolUseBlockName
Accepts one of the following:
const BetaServerToolUseBlockNameWebSearch BetaServerToolUseBlockName = "web_search"
const BetaServerToolUseBlockNameWebFetch BetaServerToolUseBlockName = "web_fetch"
const BetaServerToolUseBlockNameCodeExecution BetaServerToolUseBlockName = "code_execution"
const BetaServerToolUseBlockNameBashCodeExecution BetaServerToolUseBlockName = "bash_code_execution"
const BetaServerToolUseBlockNameTextEditorCodeExecution BetaServerToolUseBlockName = "text_editor_code_execution"
const BetaServerToolUseBlockNameToolSearchToolRegex BetaServerToolUseBlockName = "tool_search_tool_regex"
const BetaServerToolUseBlockNameToolSearchToolBm25 BetaServerToolUseBlockName = "tool_search_tool_bm25"
Type ServerToolUse
Type ServerToolUse
Accepts one of the following:
const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"
type BetaWebSearchToolResultBlock struct{…}
type BetaWebSearchToolResultBlock struct{…}
Accepts one of the following:
type BetaWebSearchToolResultError struct{…}
type BetaWebSearchToolResultError struct{…}
ErrorCode BetaWebSearchToolResultErrorCode
ErrorCode BetaWebSearchToolResultErrorCode
Accepts one of the following:
const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"
const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"
const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"
const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"
Type WebSearchToolResultError
Type WebSearchToolResultError
Accepts one of the following:
const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"
EncryptedContent string
PageAge string
Title string
Type WebSearchResult
Type WebSearchResult
Accepts one of the following:
const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"
URL string
ToolUseID string
Type WebSearchToolResult
Type WebSearchToolResult
Accepts one of the following:
const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"
type BetaWebFetchToolResultBlock struct{…}
type BetaWebFetchToolResultBlock struct{…}
Content BetaWebFetchToolResultBlockContentUnion
Content BetaWebFetchToolResultBlockContentUnion
Accepts one of the following:
type BetaWebFetchToolResultErrorBlock struct{…}
type BetaWebFetchToolResultErrorBlock struct{…}
ErrorCode BetaWebFetchToolResultErrorCode
ErrorCode BetaWebFetchToolResultErrorCode
Accepts one of the following:
const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"
const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"
const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"
const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"
const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"
const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"
Type WebFetchToolResultError
Type WebFetchToolResultError
Accepts one of the following:
const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"
type BetaWebFetchBlock struct{…}
type BetaWebFetchBlock struct{…}
Content BetaDocumentBlock
Content BetaDocumentBlock
Citations BetaCitationConfig
Citations BetaCitationConfig
Citation configuration for the document
Enabled bool
Source BetaDocumentBlockSourceUnion
Source BetaDocumentBlockSourceUnion
Accepts one of the following:
type BetaBase64PDFSource struct{…}
type BetaBase64PDFSource struct{…}
Data string
MediaType ApplicationPDF
MediaType ApplicationPDF
Accepts one of the following:
const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaPlainTextSource struct{…}
type BetaPlainTextSource struct{…}
Data string
MediaType TextPlain
MediaType TextPlain
Accepts one of the following:
const TextPlainTextPlain TextPlain = "text/plain"
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Title string
Title string
The title of the document
Type Document
Type Document
Accepts one of the following:
const DocumentDocument Document = "document"
RetrievedAt string
RetrievedAt string
ISO 8601 timestamp when the content was retrieved
Type WebFetchResult
Type WebFetchResult
Accepts one of the following:
const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"
URL string
URL string
Fetched content URL
ToolUseID string
Type WebFetchToolResult
Type WebFetchToolResult
Accepts one of the following:
const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"
type BetaCodeExecutionToolResultBlock struct{…}
type BetaCodeExecutionToolResultBlock struct{…}
Accepts one of the following:
type BetaCodeExecutionToolResultError struct{…}
type BetaCodeExecutionToolResultError struct{…}
ErrorCode BetaCodeExecutionToolResultErrorCode
ErrorCode BetaCodeExecutionToolResultErrorCode
Accepts one of the following:
const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"
const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"
const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"
const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"
Type CodeExecutionToolResultError
Type CodeExecutionToolResultError
Accepts one of the following:
const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"
type BetaCodeExecutionResultBlock struct{…}
type BetaCodeExecutionResultBlock struct{…}
Content []BetaCodeExecutionOutputBlock
Content []BetaCodeExecutionOutputBlock
FileID string
Type CodeExecutionOutput
Type CodeExecutionOutput
Accepts one of the following:
const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type CodeExecutionResult
Type CodeExecutionResult
Accepts one of the following:
const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"
ToolUseID string
Type CodeExecutionToolResult
Type CodeExecutionToolResult
Accepts one of the following:
const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"
type BetaBashCodeExecutionToolResultBlock struct{…}
type BetaBashCodeExecutionToolResultBlock struct{…}
Content BetaBashCodeExecutionToolResultBlockContentUnion
Content BetaBashCodeExecutionToolResultBlockContentUnion
Accepts one of the following:
type BetaBashCodeExecutionToolResultError struct{…}
type BetaBashCodeExecutionToolResultError struct{…}
ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode
ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode
Accepts one of the following:
const BetaBashCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"
const BetaBashCodeExecutionToolResultErrorErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorErrorCode = "unavailable"
const BetaBashCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorErrorCode = "too_many_requests"
const BetaBashCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"
const BetaBashCodeExecutionToolResultErrorErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorErrorCode = "output_file_too_large"
Type BashCodeExecutionToolResultError
Type BashCodeExecutionToolResultError
Accepts one of the following:
const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"
type BetaBashCodeExecutionResultBlock struct{…}
type BetaBashCodeExecutionResultBlock struct{…}
Content []BetaBashCodeExecutionOutputBlock
Content []BetaBashCodeExecutionOutputBlock
FileID string
Type BashCodeExecutionOutput
Type BashCodeExecutionOutput
Accepts one of the following:
const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type BashCodeExecutionResult
Type BashCodeExecutionResult
Accepts one of the following:
const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"
ToolUseID string
Type BashCodeExecutionToolResult
Type BashCodeExecutionToolResult
Accepts one of the following:
const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"
type BetaTextEditorCodeExecutionToolResultBlock struct{…}
type BetaTextEditorCodeExecutionToolResultBlock struct{…}
Content BetaTextEditorCodeExecutionToolResultBlockContentUnion
Content BetaTextEditorCodeExecutionToolResultBlockContentUnion
Accepts one of the following:
type BetaTextEditorCodeExecutionToolResultError struct{…}
type BetaTextEditorCodeExecutionToolResultError struct{…}
ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode
ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode
Accepts one of the following:
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorErrorCode = "unavailable"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorErrorCode = "too_many_requests"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorErrorCode = "file_not_found"
ErrorMessage string
Type TextEditorCodeExecutionToolResultError
Type TextEditorCodeExecutionToolResultError
Accepts one of the following:
const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"
type BetaTextEditorCodeExecutionViewResultBlock struct{…}
type BetaTextEditorCodeExecutionViewResultBlock struct{…}
Content string
FileType BetaTextEditorCodeExecutionViewResultBlockFileType
FileType BetaTextEditorCodeExecutionViewResultBlockFileType
Accepts one of the following:
const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"
const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"
const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"
NumLines int64
StartLine int64
TotalLines int64
Type TextEditorCodeExecutionViewResult
Type TextEditorCodeExecutionViewResult
Accepts one of the following:
const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"
type BetaTextEditorCodeExecutionCreateResultBlock struct{…}
type BetaTextEditorCodeExecutionCreateResultBlock struct{…}
IsFileUpdate bool
Type TextEditorCodeExecutionCreateResult
Type TextEditorCodeExecutionCreateResult
Accepts one of the following:
const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"
type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}
type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}
Lines []string
NewLines int64
NewStart int64
OldLines int64
OldStart int64
Type TextEditorCodeExecutionStrReplaceResult
Type TextEditorCodeExecutionStrReplaceResult
Accepts one of the following:
const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"
ToolUseID string
Type TextEditorCodeExecutionToolResult
Type TextEditorCodeExecutionToolResult
Accepts one of the following:
const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"
type BetaToolSearchToolResultBlock struct{…}
type BetaToolSearchToolResultBlock struct{…}
Content BetaToolSearchToolResultBlockContentUnion
Content BetaToolSearchToolResultBlockContentUnion
Accepts one of the following:
type BetaToolSearchToolResultError struct{…}
type BetaToolSearchToolResultError struct{…}
ErrorCode BetaToolSearchToolResultErrorErrorCode
ErrorCode BetaToolSearchToolResultErrorErrorCode
Accepts one of the following:
const BetaToolSearchToolResultErrorErrorCodeInvalidToolInput BetaToolSearchToolResultErrorErrorCode = "invalid_tool_input"
const BetaToolSearchToolResultErrorErrorCodeUnavailable BetaToolSearchToolResultErrorErrorCode = "unavailable"
const BetaToolSearchToolResultErrorErrorCodeTooManyRequests BetaToolSearchToolResultErrorErrorCode = "too_many_requests"
const BetaToolSearchToolResultErrorErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorErrorCode = "execution_time_exceeded"
ErrorMessage string
Type ToolSearchToolResultError
Type ToolSearchToolResultError
Accepts one of the following:
const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"
type BetaToolSearchToolSearchResultBlock struct{…}
type BetaToolSearchToolSearchResultBlock struct{…}
ToolReferences []BetaToolReferenceBlock
ToolReferences []BetaToolReferenceBlock
ToolName string
Type ToolReference
Type ToolReference
Accepts one of the following:
const ToolReferenceToolReference ToolReference = "tool_reference"
Type ToolSearchToolSearchResult
Type ToolSearchToolSearchResult
Accepts one of the following:
const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"
ToolUseID string
Type ToolSearchToolResult
Type ToolSearchToolResult
Accepts one of the following:
const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"
type BetaMCPToolUseBlock struct{…}
type BetaMCPToolUseBlock struct{…}
ID string
Input map[string, any]
Name string
Name string
The name of the MCP tool
ServerName string
ServerName string
The name of the MCP server
Type MCPToolUse
Type MCPToolUse
Accepts one of the following:
const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"
type BetaMCPToolResultBlock struct{…}
type BetaMCPToolResultBlock struct{…}
Content BetaMCPToolResultBlockContentUnion
Content BetaMCPToolResultBlockContentUnion
Accepts one of the following:
string
Citations []BetaTextCitationUnion
Citations []BetaTextCitationUnion
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
Accepts one of the following:
type BetaCitationCharLocation struct{…}
type BetaCitationCharLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
FileID string
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
IsError bool
ToolUseID string
Type MCPToolResult
Type MCPToolResult
Accepts one of the following:
const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"
type BetaContainerUploadBlock struct{…}
type BetaContainerUploadBlock struct{…}
Response model for a file uploaded to the container.
FileID string
Type ContainerUpload
Type ContainerUpload
Accepts one of the following:
const ContainerUploadContainerUpload ContainerUpload = "container_upload"
Index int64
Type ContentBlockStart
Type ContentBlockStart
Accepts one of the following:
const ContentBlockStartContentBlockStart ContentBlockStart = "content_block_start"
type BetaRawContentBlockDeltaEvent struct{…}
type BetaRawContentBlockDeltaEvent struct{…}
Accepts one of the following:
type BetaTextDelta struct{…}
type BetaTextDelta struct{…}
Text string
Type TextDelta
Type TextDelta
Accepts one of the following:
const TextDeltaTextDelta TextDelta = "text_delta"
type BetaInputJSONDelta struct{…}
type BetaInputJSONDelta struct{…}
PartialJSON string
Type InputJSONDelta
Type InputJSONDelta
Accepts one of the following:
const InputJSONDeltaInputJSONDelta InputJSONDelta = "input_json_delta"
type BetaCitationsDelta struct{…}
type BetaCitationsDelta struct{…}
Citation BetaCitationsDeltaCitationUnion
Citation BetaCitationsDeltaCitationUnion
Accepts one of the following:
type BetaCitationCharLocation struct{…}
type BetaCitationCharLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
FileID string
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Type CitationsDelta
Type CitationsDelta
Accepts one of the following:
const CitationsDeltaCitationsDelta CitationsDelta = "citations_delta"
type BetaThinkingDelta struct{…}
type BetaThinkingDelta struct{…}
Thinking string
Type ThinkingDelta
Type ThinkingDelta
Accepts one of the following:
const ThinkingDeltaThinkingDelta ThinkingDelta = "thinking_delta"
type BetaSignatureDelta struct{…}
type BetaSignatureDelta struct{…}
Signature string
Type SignatureDelta
Type SignatureDelta
Accepts one of the following:
const SignatureDeltaSignatureDelta SignatureDelta = "signature_delta"
Index int64
Type ContentBlockDelta
Type ContentBlockDelta
Accepts one of the following:
const ContentBlockDeltaContentBlockDelta ContentBlockDelta = "content_block_delta"
type BetaRawContentBlockStopEvent struct{…}
type BetaRawContentBlockStopEvent struct{…}
Index int64
Type ContentBlockStop
Type ContentBlockStop
Accepts one of the following:
const ContentBlockStopContentBlockStop ContentBlockStop = "content_block_stop"
type BetaRedactedThinkingBlock struct{…}
type BetaRedactedThinkingBlock struct{…}
Data string
Type RedactedThinking
Type RedactedThinking
Accepts one of the following:
const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"
type BetaRedactedThinkingBlockParamResp struct{…}
type BetaRedactedThinkingBlockParamResp struct{…}
Data string
Type RedactedThinking
Type RedactedThinking
Accepts one of the following:
const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"
type BetaRequestDocumentBlock struct{…}
type BetaRequestDocumentBlock struct{…}
Source BetaRequestDocumentBlockSourceUnion
Source BetaRequestDocumentBlockSourceUnion
Accepts one of the following:
type BetaBase64PDFSource struct{…}
type BetaBase64PDFSource struct{…}
Data string
MediaType ApplicationPDF
MediaType ApplicationPDF
Accepts one of the following:
const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaPlainTextSource struct{…}
type BetaPlainTextSource struct{…}
Data string
MediaType TextPlain
MediaType TextPlain
Accepts one of the following:
const TextPlainTextPlain TextPlain = "text/plain"
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
type BetaContentBlockSource struct{…}
type BetaContentBlockSource struct{…}
Content BetaContentBlockSourceContentUnion
Content BetaContentBlockSourceContentUnion
Accepts one of the following:
string
Accepts one of the following:
type BetaTextBlockParamResp struct{…}
type BetaTextBlockParamResp struct{…}
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
type BetaImageBlockParamResp struct{…}
type BetaImageBlockParamResp struct{…}
Source BetaImageBlockParamSourceUnionResp
Source BetaImageBlockParamSourceUnionResp
Accepts one of the following:
type BetaBase64ImageSource struct{…}
type BetaBase64ImageSource struct{…}
Data string
MediaType BetaBase64ImageSourceMediaType
MediaType BetaBase64ImageSourceMediaType
Accepts one of the following:
const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"
const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"
const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"
const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaURLImageSource struct{…}
type BetaURLImageSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileImageSource struct{…}
type BetaFileImageSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Image
Type Image
Accepts one of the following:
const ImageImage Image = "image"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Type Content
Type Content
Accepts one of the following:
const ContentContent Content = "content"
type BetaURLPDFSource struct{…}
type BetaURLPDFSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileDocumentSource struct{…}
type BetaFileDocumentSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Document
Type Document
Accepts one of the following:
const DocumentDocument Document = "document"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Enabled booloptional
Context stringoptional
Title stringoptional
type BetaRequestMCPServerToolConfiguration struct{…}
type BetaRequestMCPServerToolConfiguration struct{…}
AllowedTools []stringoptional
Enabled booloptional
type BetaRequestMCPServerURLDefinition struct{…}
type BetaRequestMCPServerURLDefinition struct{…}
Name string
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
AuthorizationToken stringoptional
AllowedTools []stringoptional
Enabled booloptional
type BetaRequestMCPToolResultBlockParamResp struct{…}
type BetaRequestMCPToolResultBlockParamResp struct{…}
ToolUseID string
Type MCPToolResult
Type MCPToolResult
Accepts one of the following:
const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Content BetaRequestMCPToolResultBlockParamContentUnionRespoptional
Content BetaRequestMCPToolResultBlockParamContentUnionRespoptional
Accepts one of the following:
string
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
IsError booloptional
type BetaSearchResultBlockParamResp struct{…}
type BetaSearchResultBlockParamResp struct{…}
Content []BetaTextBlockParamResp
Content []BetaTextBlockParamResp
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Source string
Title string
Type SearchResult
Type SearchResult
Accepts one of the following:
const SearchResultSearchResult SearchResult = "search_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Enabled booloptional
type BetaServerToolCaller struct{…}
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
type BetaServerToolUsage struct{…}
type BetaServerToolUsage struct{…}
WebFetchRequests int64
WebFetchRequests int64
The number of web fetch tool requests.
minimum0
WebSearchRequests int64
WebSearchRequests int64
The number of web search tool requests.
minimum0
type BetaServerToolUseBlock struct{…}
type BetaServerToolUseBlock struct{…}
ID string
Caller BetaServerToolUseBlockCallerUnion
Caller BetaServerToolUseBlockCallerUnion
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
Type Direct
Accepts one of the following:
const DirectDirect Direct = "direct"
type BetaServerToolCaller struct{…}
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
Input map[string, any]
Name BetaServerToolUseBlockName
Name BetaServerToolUseBlockName
Accepts one of the following:
const BetaServerToolUseBlockNameWebSearch BetaServerToolUseBlockName = "web_search"
const BetaServerToolUseBlockNameWebFetch BetaServerToolUseBlockName = "web_fetch"
const BetaServerToolUseBlockNameCodeExecution BetaServerToolUseBlockName = "code_execution"
const BetaServerToolUseBlockNameBashCodeExecution BetaServerToolUseBlockName = "bash_code_execution"
const BetaServerToolUseBlockNameTextEditorCodeExecution BetaServerToolUseBlockName = "text_editor_code_execution"
const BetaServerToolUseBlockNameToolSearchToolRegex BetaServerToolUseBlockName = "tool_search_tool_regex"
const BetaServerToolUseBlockNameToolSearchToolBm25 BetaServerToolUseBlockName = "tool_search_tool_bm25"
Type ServerToolUse
Type ServerToolUse
Accepts one of the following:
const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"
type BetaServerToolUseBlockParamResp struct{…}
type BetaServerToolUseBlockParamResp struct{…}
ID string
Input map[string, any]
Name BetaServerToolUseBlockParamName
Name BetaServerToolUseBlockParamName
Accepts one of the following:
const BetaServerToolUseBlockParamNameWebSearch BetaServerToolUseBlockParamName = "web_search"
const BetaServerToolUseBlockParamNameWebFetch BetaServerToolUseBlockParamName = "web_fetch"
const BetaServerToolUseBlockParamNameCodeExecution BetaServerToolUseBlockParamName = "code_execution"
const BetaServerToolUseBlockParamNameBashCodeExecution BetaServerToolUseBlockParamName = "bash_code_execution"
const BetaServerToolUseBlockParamNameTextEditorCodeExecution BetaServerToolUseBlockParamName = "text_editor_code_execution"
const BetaServerToolUseBlockParamNameToolSearchToolRegex BetaServerToolUseBlockParamName = "tool_search_tool_regex"
const BetaServerToolUseBlockParamNameToolSearchToolBm25 BetaServerToolUseBlockParamName = "tool_search_tool_bm25"
Type ServerToolUse
Type ServerToolUse
Accepts one of the following:
const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Caller BetaServerToolUseBlockParamCallerUnionRespoptional
Caller BetaServerToolUseBlockParamCallerUnionRespoptional
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
Type Direct
Accepts one of the following:
const DirectDirect Direct = "direct"
type BetaServerToolCaller struct{…}
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
type BetaSignatureDelta struct{…}
type BetaSignatureDelta struct{…}
Signature string
Type SignatureDelta
Type SignatureDelta
Accepts one of the following:
const SignatureDeltaSignatureDelta SignatureDelta = "signature_delta"
type BetaSkill struct{…}
type BetaSkill struct{…}
A skill that was loaded in a container (response model).
SkillID string
SkillID string
Skill ID
maxLength64
minLength1
Type BetaSkillType
Type BetaSkillType
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Accepts one of the following:
const BetaSkillTypeAnthropic BetaSkillType = "anthropic"
const BetaSkillTypeCustom BetaSkillType = "custom"
Version string
Version string
Skill version or 'latest' for most recent version
maxLength64
minLength1
type BetaSkillParamsResp struct{…}
type BetaSkillParamsResp struct{…}
Specification for a skill to be loaded in a container (request model).
SkillID string
SkillID string
Skill ID
maxLength64
minLength1
Type BetaSkillParamsType
Type BetaSkillParamsType
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Accepts one of the following:
const BetaSkillParamsTypeAnthropic BetaSkillParamsType = "anthropic"
const BetaSkillParamsTypeCustom BetaSkillParamsType = "custom"
Version stringoptional
Version stringoptional
Skill version or 'latest' for most recent version
maxLength64
minLength1
type BetaStopReason string
type BetaStopReason string
Accepts one of the following:
type BetaTextBlock struct{…}
type BetaTextBlock struct{…}
Citations []BetaTextCitationUnion
Citations []BetaTextCitationUnion
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
Accepts one of the following:
type BetaCitationCharLocation struct{…}
type BetaCitationCharLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
FileID string
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
type BetaTextBlockParamResp struct{…}
type BetaTextBlockParamResp struct{…}
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
type BetaTextCitationUnion interface{…}
type BetaTextCitationUnion interface{…}
Accepts one of the following:
type BetaCitationCharLocation struct{…}
type BetaCitationCharLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
FileID string
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
type BetaTextCitationParamUnionResp interface{…}
type BetaTextCitationParamUnionResp interface{…}
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
type BetaTextDelta struct{…}
type BetaTextDelta struct{…}
Text string
Type TextDelta
Type TextDelta
Accepts one of the following:
const TextDeltaTextDelta TextDelta = "text_delta"
type BetaTextEditorCodeExecutionCreateResultBlock struct{…}
type BetaTextEditorCodeExecutionCreateResultBlock struct{…}
IsFileUpdate bool
Type TextEditorCodeExecutionCreateResult
Type TextEditorCodeExecutionCreateResult
Accepts one of the following:
const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"
type BetaTextEditorCodeExecutionCreateResultBlockParamResp struct{…}
type BetaTextEditorCodeExecutionCreateResultBlockParamResp struct{…}
IsFileUpdate bool
Type TextEditorCodeExecutionCreateResult
Type TextEditorCodeExecutionCreateResult
Accepts one of the following:
const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"
type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}
type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}
Lines []string
NewLines int64
NewStart int64
OldLines int64
OldStart int64
Type TextEditorCodeExecutionStrReplaceResult
Type TextEditorCodeExecutionStrReplaceResult
Accepts one of the following:
const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"
type BetaTextEditorCodeExecutionStrReplaceResultBlockParamResp struct{…}
type BetaTextEditorCodeExecutionStrReplaceResultBlockParamResp struct{…}
Type TextEditorCodeExecutionStrReplaceResult
Type TextEditorCodeExecutionStrReplaceResult
Accepts one of the following:
const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"
Lines []stringoptional
NewLines int64optional
NewStart int64optional
OldLines int64optional
OldStart int64optional
type BetaTextEditorCodeExecutionToolResultBlock struct{…}
type BetaTextEditorCodeExecutionToolResultBlock struct{…}
Content BetaTextEditorCodeExecutionToolResultBlockContentUnion
Content BetaTextEditorCodeExecutionToolResultBlockContentUnion
Accepts one of the following:
type BetaTextEditorCodeExecutionToolResultError struct{…}
type BetaTextEditorCodeExecutionToolResultError struct{…}
ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode
ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode
Accepts one of the following:
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorErrorCode = "unavailable"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorErrorCode = "too_many_requests"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorErrorCode = "file_not_found"
ErrorMessage string
Type TextEditorCodeExecutionToolResultError
Type TextEditorCodeExecutionToolResultError
Accepts one of the following:
const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"
type BetaTextEditorCodeExecutionViewResultBlock struct{…}
type BetaTextEditorCodeExecutionViewResultBlock struct{…}
Content string
FileType BetaTextEditorCodeExecutionViewResultBlockFileType
FileType BetaTextEditorCodeExecutionViewResultBlockFileType
Accepts one of the following:
const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"
const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"
const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"
NumLines int64
StartLine int64
TotalLines int64
Type TextEditorCodeExecutionViewResult
Type TextEditorCodeExecutionViewResult
Accepts one of the following:
const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"
type BetaTextEditorCodeExecutionCreateResultBlock struct{…}
type BetaTextEditorCodeExecutionCreateResultBlock struct{…}
IsFileUpdate bool
Type TextEditorCodeExecutionCreateResult
Type TextEditorCodeExecutionCreateResult
Accepts one of the following:
const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"
type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}
type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}
Lines []string
NewLines int64
NewStart int64
OldLines int64
OldStart int64
Type TextEditorCodeExecutionStrReplaceResult
Type TextEditorCodeExecutionStrReplaceResult
Accepts one of the following:
const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"
ToolUseID string
Type TextEditorCodeExecutionToolResult
Type TextEditorCodeExecutionToolResult
Accepts one of the following:
const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"
type BetaTextEditorCodeExecutionToolResultBlockParamResp struct{…}
type BetaTextEditorCodeExecutionToolResultBlockParamResp struct{…}
Content BetaTextEditorCodeExecutionToolResultBlockParamContentUnionResp
Content BetaTextEditorCodeExecutionToolResultBlockParamContentUnionResp
Accepts one of the following:
type BetaTextEditorCodeExecutionToolResultErrorParamResp struct{…}
type BetaTextEditorCodeExecutionToolResultErrorParamResp struct{…}
ErrorCode BetaTextEditorCodeExecutionToolResultErrorParamErrorCode
ErrorCode BetaTextEditorCodeExecutionToolResultErrorParamErrorCode
Accepts one of the following:
const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "invalid_tool_input"
const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "unavailable"
const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "too_many_requests"
const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "execution_time_exceeded"
const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "file_not_found"
Type TextEditorCodeExecutionToolResultError
Type TextEditorCodeExecutionToolResultError
Accepts one of the following:
const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"
ErrorMessage stringoptional
type BetaTextEditorCodeExecutionViewResultBlockParamResp struct{…}
type BetaTextEditorCodeExecutionViewResultBlockParamResp struct{…}
Content string
FileType BetaTextEditorCodeExecutionViewResultBlockParamFileType
FileType BetaTextEditorCodeExecutionViewResultBlockParamFileType
Accepts one of the following:
const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeText BetaTextEditorCodeExecutionViewResultBlockParamFileType = "text"
const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeImage BetaTextEditorCodeExecutionViewResultBlockParamFileType = "image"
const BetaTextEditorCodeExecutionViewResultBlockParamFileTypePDF BetaTextEditorCodeExecutionViewResultBlockParamFileType = "pdf"
Type TextEditorCodeExecutionViewResult
Type TextEditorCodeExecutionViewResult
Accepts one of the following:
const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"
NumLines int64optional
StartLine int64optional
TotalLines int64optional
type BetaTextEditorCodeExecutionCreateResultBlockParamResp struct{…}
type BetaTextEditorCodeExecutionCreateResultBlockParamResp struct{…}
IsFileUpdate bool
Type TextEditorCodeExecutionCreateResult
Type TextEditorCodeExecutionCreateResult
Accepts one of the following:
const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"
type BetaTextEditorCodeExecutionStrReplaceResultBlockParamResp struct{…}
type BetaTextEditorCodeExecutionStrReplaceResultBlockParamResp struct{…}
Type TextEditorCodeExecutionStrReplaceResult
Type TextEditorCodeExecutionStrReplaceResult
Accepts one of the following:
const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"
Lines []stringoptional
NewLines int64optional
NewStart int64optional
OldLines int64optional
OldStart int64optional
ToolUseID string
Type TextEditorCodeExecutionToolResult
Type TextEditorCodeExecutionToolResult
Accepts one of the following:
const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaTextEditorCodeExecutionToolResultError struct{…}
type BetaTextEditorCodeExecutionToolResultError struct{…}
ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode
ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode
Accepts one of the following:
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorErrorCode = "unavailable"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorErrorCode = "too_many_requests"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorErrorCode = "file_not_found"
ErrorMessage string
Type TextEditorCodeExecutionToolResultError
Type TextEditorCodeExecutionToolResultError
Accepts one of the following:
const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"
type BetaTextEditorCodeExecutionToolResultErrorParamResp struct{…}
type BetaTextEditorCodeExecutionToolResultErrorParamResp struct{…}
ErrorCode BetaTextEditorCodeExecutionToolResultErrorParamErrorCode
ErrorCode BetaTextEditorCodeExecutionToolResultErrorParamErrorCode
Accepts one of the following:
const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "invalid_tool_input"
const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "unavailable"
const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "too_many_requests"
const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "execution_time_exceeded"
const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "file_not_found"
Type TextEditorCodeExecutionToolResultError
Type TextEditorCodeExecutionToolResultError
Accepts one of the following:
const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"
ErrorMessage stringoptional
type BetaTextEditorCodeExecutionViewResultBlock struct{…}
type BetaTextEditorCodeExecutionViewResultBlock struct{…}
Content string
FileType BetaTextEditorCodeExecutionViewResultBlockFileType
FileType BetaTextEditorCodeExecutionViewResultBlockFileType
Accepts one of the following:
const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"
const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"
const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"
NumLines int64
StartLine int64
TotalLines int64
Type TextEditorCodeExecutionViewResult
Type TextEditorCodeExecutionViewResult
Accepts one of the following:
const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"
type BetaTextEditorCodeExecutionViewResultBlockParamResp struct{…}
type BetaTextEditorCodeExecutionViewResultBlockParamResp struct{…}
Content string
FileType BetaTextEditorCodeExecutionViewResultBlockParamFileType
FileType BetaTextEditorCodeExecutionViewResultBlockParamFileType
Accepts one of the following:
const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeText BetaTextEditorCodeExecutionViewResultBlockParamFileType = "text"
const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeImage BetaTextEditorCodeExecutionViewResultBlockParamFileType = "image"
const BetaTextEditorCodeExecutionViewResultBlockParamFileTypePDF BetaTextEditorCodeExecutionViewResultBlockParamFileType = "pdf"
Type TextEditorCodeExecutionViewResult
Type TextEditorCodeExecutionViewResult
Accepts one of the following:
const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"
NumLines int64optional
StartLine int64optional
TotalLines int64optional
type BetaThinkingBlock struct{…}
type BetaThinkingBlock struct{…}
Signature string
Thinking string
Type Thinking
Type Thinking
Accepts one of the following:
const ThinkingThinking Thinking = "thinking"
type BetaThinkingBlockParamResp struct{…}
type BetaThinkingBlockParamResp struct{…}
Signature string
Thinking string
Type Thinking
Type Thinking
Accepts one of the following:
const ThinkingThinking Thinking = "thinking"
type BetaThinkingConfigDisabled struct{…}
type BetaThinkingConfigDisabled struct{…}
Type Disabled
Type Disabled
Accepts one of the following:
const DisabledDisabled Disabled = "disabled"
type BetaThinkingConfigEnabled struct{…}
type BetaThinkingConfigEnabled struct{…}
BudgetTokens int64
BudgetTokens int64
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 Enabled
Type Enabled
Accepts one of the following:
const EnabledEnabled Enabled = "enabled"
type BetaThinkingConfigParamUnionResp interface{…}
type BetaThinkingConfigParamUnionResp interface{…}
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.
Accepts one of the following:
type BetaThinkingConfigEnabled struct{…}
type BetaThinkingConfigEnabled struct{…}
BudgetTokens int64
BudgetTokens int64
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 Enabled
Type Enabled
Accepts one of the following:
const EnabledEnabled Enabled = "enabled"
type BetaThinkingConfigDisabled struct{…}
type BetaThinkingConfigDisabled struct{…}
Type Disabled
Type Disabled
Accepts one of the following:
const DisabledDisabled Disabled = "disabled"
type BetaThinkingDelta struct{…}
type BetaThinkingDelta struct{…}
Thinking string
Type ThinkingDelta
Type ThinkingDelta
Accepts one of the following:
const ThinkingDeltaThinkingDelta ThinkingDelta = "thinking_delta"
type BetaThinkingTurns struct{…}
type BetaThinkingTurns struct{…}
Type ThinkingTurns
Type ThinkingTurns
Accepts one of the following:
const ThinkingTurnsThinkingTurns ThinkingTurns = "thinking_turns"
Value int64
type BetaTool struct{…}
type BetaTool struct{…}
InputSchema BetaToolInputSchema
InputSchema BetaToolInputSchema
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 Object
Type Object
Accepts one of the following:
const ObjectObject Object = "object"
Properties map[string, any]optional
Required []stringoptional
Name string
Name string
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
maxLength128
minLength1
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaToolAllowedCallerDirect BetaToolAllowedCaller = "direct"
const BetaToolAllowedCallerCodeExecution20250825 BetaToolAllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Description stringoptional
Description stringoptional
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.
InputExamples []map[string, any]optional
Strict booloptional
Type BetaToolTypeoptional
Type BetaToolTypeoptional
Accepts one of the following:
const BetaToolTypeCustom BetaToolType = "custom"
type BetaToolBash20241022 struct{…}
type BetaToolBash20241022 struct{…}
Name Bash
Name Bash
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:
const BashBash Bash = "bash"
Type Bash20241022
Type Bash20241022
Accepts one of the following:
const Bash20241022Bash20241022 Bash20241022 = "bash_20241022"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"
const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
InputExamples []map[string, any]optional
Strict booloptional
type BetaToolBash20250124 struct{…}
type BetaToolBash20250124 struct{…}
Name Bash
Name Bash
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:
const BashBash Bash = "bash"
Type Bash20250124
Type Bash20250124
Accepts one of the following:
const Bash20250124Bash20250124 Bash20250124 = "bash_20250124"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"
const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
InputExamples []map[string, any]optional
Strict booloptional
type BetaToolChoiceUnion interface{…}
type BetaToolChoiceUnion interface{…}
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.
Accepts one of the following:
type BetaToolChoiceAuto struct{…}
type BetaToolChoiceAuto struct{…}
The model will automatically decide whether to use tools.
Type Auto
Type Auto
Accepts one of the following:
const AutoAuto Auto = "auto"
DisableParallelToolUse booloptional
DisableParallelToolUse booloptional
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output at most one tool use.
type BetaToolChoiceAny struct{…}
type BetaToolChoiceAny struct{…}
The model will use any available tools.
Type Any
Type Any
Accepts one of the following:
const AnyAny Any = "any"
DisableParallelToolUse booloptional
DisableParallelToolUse booloptional
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
type BetaToolChoiceTool struct{…}
type BetaToolChoiceTool struct{…}
The model will use the specified tool with tool_choice.name.
Name string
Name string
The name of the tool to use.
Type Tool
Type Tool
Accepts one of the following:
const ToolTool Tool = "tool"
DisableParallelToolUse booloptional
DisableParallelToolUse booloptional
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
type BetaToolChoiceNone struct{…}
type BetaToolChoiceNone struct{…}
The model will not be allowed to use tools.
Type None
Type None
Accepts one of the following:
const NoneNone None = "none"
type BetaToolChoiceAny struct{…}
type BetaToolChoiceAny struct{…}
The model will use any available tools.
Type Any
Type Any
Accepts one of the following:
const AnyAny Any = "any"
DisableParallelToolUse booloptional
DisableParallelToolUse booloptional
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
type BetaToolChoiceAuto struct{…}
type BetaToolChoiceAuto struct{…}
The model will automatically decide whether to use tools.
Type Auto
Type Auto
Accepts one of the following:
const AutoAuto Auto = "auto"
DisableParallelToolUse booloptional
DisableParallelToolUse booloptional
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output at most one tool use.
type BetaToolChoiceNone struct{…}
type BetaToolChoiceNone struct{…}
The model will not be allowed to use tools.
Type None
Type None
Accepts one of the following:
const NoneNone None = "none"
type BetaToolChoiceTool struct{…}
type BetaToolChoiceTool struct{…}
The model will use the specified tool with tool_choice.name.
Name string
Name string
The name of the tool to use.
Type Tool
Type Tool
Accepts one of the following:
const ToolTool Tool = "tool"
DisableParallelToolUse booloptional
DisableParallelToolUse booloptional
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
type BetaToolComputerUse20241022 struct{…}
type BetaToolComputerUse20241022 struct{…}
DisplayHeightPx int64
DisplayHeightPx int64
The height of the display in pixels.
minimum1
DisplayWidthPx int64
DisplayWidthPx int64
The width of the display in pixels.
minimum1
Name Computer
Name Computer
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:
const ComputerComputer Computer = "computer"
Type Computer20241022
Type Computer20241022
Accepts one of the following:
const Computer20241022Computer20241022 Computer20241022 = "computer_20241022"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"
const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
DisplayNumber int64optional
DisplayNumber int64optional
The X11 display number (e.g. 0, 1) for the display.
minimum0
InputExamples []map[string, any]optional
Strict booloptional
type BetaToolComputerUse20250124 struct{…}
type BetaToolComputerUse20250124 struct{…}
DisplayHeightPx int64
DisplayHeightPx int64
The height of the display in pixels.
minimum1
DisplayWidthPx int64
DisplayWidthPx int64
The width of the display in pixels.
minimum1
Name Computer
Name Computer
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:
const ComputerComputer Computer = "computer"
Type Computer20250124
Type Computer20250124
Accepts one of the following:
const Computer20250124Computer20250124 Computer20250124 = "computer_20250124"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"
const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
DisplayNumber int64optional
DisplayNumber int64optional
The X11 display number (e.g. 0, 1) for the display.
minimum0
InputExamples []map[string, any]optional
Strict booloptional
type BetaToolComputerUse20251124 struct{…}
type BetaToolComputerUse20251124 struct{…}
DisplayHeightPx int64
DisplayHeightPx int64
The height of the display in pixels.
minimum1
DisplayWidthPx int64
DisplayWidthPx int64
The width of the display in pixels.
minimum1
Name Computer
Name Computer
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:
const ComputerComputer Computer = "computer"
Type Computer20251124
Type Computer20251124
Accepts one of the following:
const Computer20251124Computer20251124 Computer20251124 = "computer_20251124"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"
const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
DisplayNumber int64optional
DisplayNumber int64optional
The X11 display number (e.g. 0, 1) for the display.
minimum0
EnableZoom booloptional
EnableZoom booloptional
Whether to enable an action to take a zoomed-in screenshot of the screen.
InputExamples []map[string, any]optional
Strict booloptional
type BetaToolReferenceBlock struct{…}
type BetaToolReferenceBlock struct{…}
ToolName string
Type ToolReference
Type ToolReference
Accepts one of the following:
const ToolReferenceToolReference ToolReference = "tool_reference"
type BetaToolReferenceBlockParamResp struct{…}
type BetaToolReferenceBlockParamResp struct{…}
Tool reference block that can be included in tool_result content.
ToolName string
Type ToolReference
Type ToolReference
Accepts one of the following:
const ToolReferenceToolReference ToolReference = "tool_reference"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaToolResultBlockParamResp struct{…}
type BetaToolResultBlockParamResp struct{…}
ToolUseID string
Type ToolResult
Type ToolResult
Accepts one of the following:
const ToolResultToolResult ToolResult = "tool_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Content []BetaToolResultBlockParamContentUnionRespoptional
Content []BetaToolResultBlockParamContentUnionRespoptional
Accepts one of the following:
[]BetaToolResultBlockParamContentUnionResp
[]BetaToolResultBlockParamContentUnionResp
Accepts one of the following:
type BetaTextBlockParamResp struct{…}
type BetaTextBlockParamResp struct{…}
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
type BetaImageBlockParamResp struct{…}
type BetaImageBlockParamResp struct{…}
Source BetaImageBlockParamSourceUnionResp
Source BetaImageBlockParamSourceUnionResp
Accepts one of the following:
type BetaBase64ImageSource struct{…}
type BetaBase64ImageSource struct{…}
Data string
MediaType BetaBase64ImageSourceMediaType
MediaType BetaBase64ImageSourceMediaType
Accepts one of the following:
const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"
const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"
const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"
const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaURLImageSource struct{…}
type BetaURLImageSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileImageSource struct{…}
type BetaFileImageSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Image
Type Image
Accepts one of the following:
const ImageImage Image = "image"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaSearchResultBlockParamResp struct{…}
type BetaSearchResultBlockParamResp struct{…}
Content []BetaTextBlockParamResp
Content []BetaTextBlockParamResp
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Source string
Title string
Type SearchResult
Type SearchResult
Accepts one of the following:
const SearchResultSearchResult SearchResult = "search_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Enabled booloptional
type BetaRequestDocumentBlock struct{…}
type BetaRequestDocumentBlock struct{…}
Source BetaRequestDocumentBlockSourceUnion
Source BetaRequestDocumentBlockSourceUnion
Accepts one of the following:
type BetaBase64PDFSource struct{…}
type BetaBase64PDFSource struct{…}
Data string
MediaType ApplicationPDF
MediaType ApplicationPDF
Accepts one of the following:
const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaPlainTextSource struct{…}
type BetaPlainTextSource struct{…}
Data string
MediaType TextPlain
MediaType TextPlain
Accepts one of the following:
const TextPlainTextPlain TextPlain = "text/plain"
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
type BetaContentBlockSource struct{…}
type BetaContentBlockSource struct{…}
Content BetaContentBlockSourceContentUnion
Content BetaContentBlockSourceContentUnion
Accepts one of the following:
string
Accepts one of the following:
type BetaTextBlockParamResp struct{…}
type BetaTextBlockParamResp struct{…}
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
type BetaImageBlockParamResp struct{…}
type BetaImageBlockParamResp struct{…}
Source BetaImageBlockParamSourceUnionResp
Source BetaImageBlockParamSourceUnionResp
Accepts one of the following:
type BetaBase64ImageSource struct{…}
type BetaBase64ImageSource struct{…}
Data string
MediaType BetaBase64ImageSourceMediaType
MediaType BetaBase64ImageSourceMediaType
Accepts one of the following:
const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"
const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"
const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"
const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaURLImageSource struct{…}
type BetaURLImageSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileImageSource struct{…}
type BetaFileImageSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Image
Type Image
Accepts one of the following:
const ImageImage Image = "image"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Type Content
Type Content
Accepts one of the following:
const ContentContent Content = "content"
type BetaURLPDFSource struct{…}
type BetaURLPDFSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileDocumentSource struct{…}
type BetaFileDocumentSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Document
Type Document
Accepts one of the following:
const DocumentDocument Document = "document"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Enabled booloptional
Context stringoptional
Title stringoptional
type BetaToolReferenceBlockParamResp struct{…}
type BetaToolReferenceBlockParamResp struct{…}
Tool reference block that can be included in tool_result content.
ToolName string
Type ToolReference
Type ToolReference
Accepts one of the following:
const ToolReferenceToolReference ToolReference = "tool_reference"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
IsError booloptional
type BetaToolSearchToolBm25_20251119 struct{…}
type BetaToolSearchToolBm25_20251119 struct{…}
Name ToolSearchToolBm25
Name ToolSearchToolBm25
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:
const ToolSearchToolBm25ToolSearchToolBm25 ToolSearchToolBm25 = "tool_search_tool_bm25"
Type BetaToolSearchToolBm25_20251119Type
Type BetaToolSearchToolBm25_20251119Type
Accepts one of the following:
const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"
const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"
const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Strict booloptional
type BetaToolSearchToolRegex20251119 struct{…}
type BetaToolSearchToolRegex20251119 struct{…}
Name ToolSearchToolRegex
Name ToolSearchToolRegex
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:
const ToolSearchToolRegexToolSearchToolRegex ToolSearchToolRegex = "tool_search_tool_regex"
Type BetaToolSearchToolRegex20251119Type
Type BetaToolSearchToolRegex20251119Type
Accepts one of the following:
const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"
const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"
const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Strict booloptional
type BetaToolSearchToolResultBlock struct{…}
type BetaToolSearchToolResultBlock struct{…}
Content BetaToolSearchToolResultBlockContentUnion
Content BetaToolSearchToolResultBlockContentUnion
Accepts one of the following:
type BetaToolSearchToolResultError struct{…}
type BetaToolSearchToolResultError struct{…}
ErrorCode BetaToolSearchToolResultErrorErrorCode
ErrorCode BetaToolSearchToolResultErrorErrorCode
Accepts one of the following:
const BetaToolSearchToolResultErrorErrorCodeInvalidToolInput BetaToolSearchToolResultErrorErrorCode = "invalid_tool_input"
const BetaToolSearchToolResultErrorErrorCodeUnavailable BetaToolSearchToolResultErrorErrorCode = "unavailable"
const BetaToolSearchToolResultErrorErrorCodeTooManyRequests BetaToolSearchToolResultErrorErrorCode = "too_many_requests"
const BetaToolSearchToolResultErrorErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorErrorCode = "execution_time_exceeded"
ErrorMessage string
Type ToolSearchToolResultError
Type ToolSearchToolResultError
Accepts one of the following:
const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"
type BetaToolSearchToolSearchResultBlock struct{…}
type BetaToolSearchToolSearchResultBlock struct{…}
ToolReferences []BetaToolReferenceBlock
ToolReferences []BetaToolReferenceBlock
ToolName string
Type ToolReference
Type ToolReference
Accepts one of the following:
const ToolReferenceToolReference ToolReference = "tool_reference"
Type ToolSearchToolSearchResult
Type ToolSearchToolSearchResult
Accepts one of the following:
const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"
ToolUseID string
Type ToolSearchToolResult
Type ToolSearchToolResult
Accepts one of the following:
const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"
type BetaToolSearchToolResultBlockParamResp struct{…}
type BetaToolSearchToolResultBlockParamResp struct{…}
Content BetaToolSearchToolResultBlockParamContentUnionResp
Content BetaToolSearchToolResultBlockParamContentUnionResp
Accepts one of the following:
type BetaToolSearchToolResultErrorParamResp struct{…}
type BetaToolSearchToolResultErrorParamResp struct{…}
ErrorCode BetaToolSearchToolResultErrorParamErrorCode
ErrorCode BetaToolSearchToolResultErrorParamErrorCode
Accepts one of the following:
const BetaToolSearchToolResultErrorParamErrorCodeInvalidToolInput BetaToolSearchToolResultErrorParamErrorCode = "invalid_tool_input"
const BetaToolSearchToolResultErrorParamErrorCodeUnavailable BetaToolSearchToolResultErrorParamErrorCode = "unavailable"
const BetaToolSearchToolResultErrorParamErrorCodeTooManyRequests BetaToolSearchToolResultErrorParamErrorCode = "too_many_requests"
const BetaToolSearchToolResultErrorParamErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorParamErrorCode = "execution_time_exceeded"
Type ToolSearchToolResultError
Type ToolSearchToolResultError
Accepts one of the following:
const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"
type BetaToolSearchToolSearchResultBlockParamResp struct{…}
type BetaToolSearchToolSearchResultBlockParamResp struct{…}
ToolReferences []BetaToolReferenceBlockParamResp
ToolReferences []BetaToolReferenceBlockParamResp
ToolName string
Type ToolReference
Type ToolReference
Accepts one of the following:
const ToolReferenceToolReference ToolReference = "tool_reference"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Type ToolSearchToolSearchResult
Type ToolSearchToolSearchResult
Accepts one of the following:
const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"
ToolUseID string
Type ToolSearchToolResult
Type ToolSearchToolResult
Accepts one of the following:
const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaToolSearchToolResultError struct{…}
type BetaToolSearchToolResultError struct{…}
ErrorCode BetaToolSearchToolResultErrorErrorCode
ErrorCode BetaToolSearchToolResultErrorErrorCode
Accepts one of the following:
const BetaToolSearchToolResultErrorErrorCodeInvalidToolInput BetaToolSearchToolResultErrorErrorCode = "invalid_tool_input"
const BetaToolSearchToolResultErrorErrorCodeUnavailable BetaToolSearchToolResultErrorErrorCode = "unavailable"
const BetaToolSearchToolResultErrorErrorCodeTooManyRequests BetaToolSearchToolResultErrorErrorCode = "too_many_requests"
const BetaToolSearchToolResultErrorErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorErrorCode = "execution_time_exceeded"
ErrorMessage string
Type ToolSearchToolResultError
Type ToolSearchToolResultError
Accepts one of the following:
const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"
type BetaToolSearchToolResultErrorParamResp struct{…}
type BetaToolSearchToolResultErrorParamResp struct{…}
ErrorCode BetaToolSearchToolResultErrorParamErrorCode
ErrorCode BetaToolSearchToolResultErrorParamErrorCode
Accepts one of the following:
const BetaToolSearchToolResultErrorParamErrorCodeInvalidToolInput BetaToolSearchToolResultErrorParamErrorCode = "invalid_tool_input"
const BetaToolSearchToolResultErrorParamErrorCodeUnavailable BetaToolSearchToolResultErrorParamErrorCode = "unavailable"
const BetaToolSearchToolResultErrorParamErrorCodeTooManyRequests BetaToolSearchToolResultErrorParamErrorCode = "too_many_requests"
const BetaToolSearchToolResultErrorParamErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorParamErrorCode = "execution_time_exceeded"
Type ToolSearchToolResultError
Type ToolSearchToolResultError
Accepts one of the following:
const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"
type BetaToolSearchToolSearchResultBlock struct{…}
type BetaToolSearchToolSearchResultBlock struct{…}
ToolReferences []BetaToolReferenceBlock
ToolReferences []BetaToolReferenceBlock
ToolName string
Type ToolReference
Type ToolReference
Accepts one of the following:
const ToolReferenceToolReference ToolReference = "tool_reference"
Type ToolSearchToolSearchResult
Type ToolSearchToolSearchResult
Accepts one of the following:
const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"
type BetaToolSearchToolSearchResultBlockParamResp struct{…}
type BetaToolSearchToolSearchResultBlockParamResp struct{…}
ToolReferences []BetaToolReferenceBlockParamResp
ToolReferences []BetaToolReferenceBlockParamResp
ToolName string
Type ToolReference
Type ToolReference
Accepts one of the following:
const ToolReferenceToolReference ToolReference = "tool_reference"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Type ToolSearchToolSearchResult
Type ToolSearchToolSearchResult
Accepts one of the following:
const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"
type BetaToolTextEditor20241022 struct{…}
type BetaToolTextEditor20241022 struct{…}
Name StrReplaceEditor
Name StrReplaceEditor
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:
const StrReplaceEditorStrReplaceEditor StrReplaceEditor = "str_replace_editor"
Type TextEditor20241022
Type TextEditor20241022
Accepts one of the following:
const TextEditor20241022TextEditor20241022 TextEditor20241022 = "text_editor_20241022"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"
const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
InputExamples []map[string, any]optional
Strict booloptional
type BetaToolTextEditor20250124 struct{…}
type BetaToolTextEditor20250124 struct{…}
Name StrReplaceEditor
Name StrReplaceEditor
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:
const StrReplaceEditorStrReplaceEditor StrReplaceEditor = "str_replace_editor"
Type TextEditor20250124
Type TextEditor20250124
Accepts one of the following:
const TextEditor20250124TextEditor20250124 TextEditor20250124 = "text_editor_20250124"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"
const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
InputExamples []map[string, any]optional
Strict booloptional
type BetaToolTextEditor20250429 struct{…}
type BetaToolTextEditor20250429 struct{…}
Name StrReplaceBasedEditTool
Name StrReplaceBasedEditTool
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:
const StrReplaceBasedEditToolStrReplaceBasedEditTool StrReplaceBasedEditTool = "str_replace_based_edit_tool"
Type TextEditor20250429
Type TextEditor20250429
Accepts one of the following:
const TextEditor20250429TextEditor20250429 TextEditor20250429 = "text_editor_20250429"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"
const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
InputExamples []map[string, any]optional
Strict booloptional
type BetaToolTextEditor20250728 struct{…}
type BetaToolTextEditor20250728 struct{…}
Name StrReplaceBasedEditTool
Name StrReplaceBasedEditTool
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:
const StrReplaceBasedEditToolStrReplaceBasedEditTool StrReplaceBasedEditTool = "str_replace_based_edit_tool"
Type TextEditor20250728
Type TextEditor20250728
Accepts one of the following:
const TextEditor20250728TextEditor20250728 TextEditor20250728 = "text_editor_20250728"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"
const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
InputExamples []map[string, any]optional
MaxCharacters int64optional
MaxCharacters int64optional
Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.
minimum1
Strict booloptional
type BetaToolUnion interface{…}
type BetaToolUnion interface{…}
Configuration for a group of tools from an MCP server.
Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides.
Accepts one of the following:
type BetaTool struct{…}
type BetaTool struct{…}
InputSchema BetaToolInputSchema
InputSchema BetaToolInputSchema
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 Object
Type Object
Accepts one of the following:
const ObjectObject Object = "object"
Properties map[string, any]optional
Required []stringoptional
Name string
Name string
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
maxLength128
minLength1
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaToolAllowedCallerDirect BetaToolAllowedCaller = "direct"
const BetaToolAllowedCallerCodeExecution20250825 BetaToolAllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Description stringoptional
Description stringoptional
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.
InputExamples []map[string, any]optional
Strict booloptional
Type BetaToolTypeoptional
Type BetaToolTypeoptional
Accepts one of the following:
const BetaToolTypeCustom BetaToolType = "custom"
type BetaToolBash20241022 struct{…}
type BetaToolBash20241022 struct{…}
Name Bash
Name Bash
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:
const BashBash Bash = "bash"
Type Bash20241022
Type Bash20241022
Accepts one of the following:
const Bash20241022Bash20241022 Bash20241022 = "bash_20241022"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"
const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
InputExamples []map[string, any]optional
Strict booloptional
type BetaToolBash20250124 struct{…}
type BetaToolBash20250124 struct{…}
Name Bash
Name Bash
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:
const BashBash Bash = "bash"
Type Bash20250124
Type Bash20250124
Accepts one of the following:
const Bash20250124Bash20250124 Bash20250124 = "bash_20250124"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"
const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
InputExamples []map[string, any]optional
Strict booloptional
type BetaCodeExecutionTool20250522 struct{…}
type BetaCodeExecutionTool20250522 struct{…}
Name CodeExecution
Name CodeExecution
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:
const CodeExecutionCodeExecution CodeExecution = "code_execution"
Type CodeExecution20250522
Type CodeExecution20250522
Accepts one of the following:
const CodeExecution20250522CodeExecution20250522 CodeExecution20250522 = "code_execution_20250522"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"
const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Strict booloptional
type BetaCodeExecutionTool20250825 struct{…}
type BetaCodeExecutionTool20250825 struct{…}
Name CodeExecution
Name CodeExecution
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:
const CodeExecutionCodeExecution CodeExecution = "code_execution"
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"
const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Strict booloptional
type BetaToolComputerUse20241022 struct{…}
type BetaToolComputerUse20241022 struct{…}
DisplayHeightPx int64
DisplayHeightPx int64
The height of the display in pixels.
minimum1
DisplayWidthPx int64
DisplayWidthPx int64
The width of the display in pixels.
minimum1
Name Computer
Name Computer
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:
const ComputerComputer Computer = "computer"
Type Computer20241022
Type Computer20241022
Accepts one of the following:
const Computer20241022Computer20241022 Computer20241022 = "computer_20241022"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"
const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
DisplayNumber int64optional
DisplayNumber int64optional
The X11 display number (e.g. 0, 1) for the display.
minimum0
InputExamples []map[string, any]optional
Strict booloptional
type BetaMemoryTool20250818 struct{…}
type BetaMemoryTool20250818 struct{…}
Name Memory
Name Memory
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:
const MemoryMemory Memory = "memory"
Type Memory20250818
Type Memory20250818
Accepts one of the following:
const Memory20250818Memory20250818 Memory20250818 = "memory_20250818"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"
const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
InputExamples []map[string, any]optional
Strict booloptional
type BetaToolComputerUse20250124 struct{…}
type BetaToolComputerUse20250124 struct{…}
DisplayHeightPx int64
DisplayHeightPx int64
The height of the display in pixels.
minimum1
DisplayWidthPx int64
DisplayWidthPx int64
The width of the display in pixels.
minimum1
Name Computer
Name Computer
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:
const ComputerComputer Computer = "computer"
Type Computer20250124
Type Computer20250124
Accepts one of the following:
const Computer20250124Computer20250124 Computer20250124 = "computer_20250124"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"
const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
DisplayNumber int64optional
DisplayNumber int64optional
The X11 display number (e.g. 0, 1) for the display.
minimum0
InputExamples []map[string, any]optional
Strict booloptional
type BetaToolTextEditor20241022 struct{…}
type BetaToolTextEditor20241022 struct{…}
Name StrReplaceEditor
Name StrReplaceEditor
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:
const StrReplaceEditorStrReplaceEditor StrReplaceEditor = "str_replace_editor"
Type TextEditor20241022
Type TextEditor20241022
Accepts one of the following:
const TextEditor20241022TextEditor20241022 TextEditor20241022 = "text_editor_20241022"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"
const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
InputExamples []map[string, any]optional
Strict booloptional
type BetaToolComputerUse20251124 struct{…}
type BetaToolComputerUse20251124 struct{…}
DisplayHeightPx int64
DisplayHeightPx int64
The height of the display in pixels.
minimum1
DisplayWidthPx int64
DisplayWidthPx int64
The width of the display in pixels.
minimum1
Name Computer
Name Computer
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:
const ComputerComputer Computer = "computer"
Type Computer20251124
Type Computer20251124
Accepts one of the following:
const Computer20251124Computer20251124 Computer20251124 = "computer_20251124"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"
const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
DisplayNumber int64optional
DisplayNumber int64optional
The X11 display number (e.g. 0, 1) for the display.
minimum0
EnableZoom booloptional
EnableZoom booloptional
Whether to enable an action to take a zoomed-in screenshot of the screen.
InputExamples []map[string, any]optional
Strict booloptional
type BetaToolTextEditor20250124 struct{…}
type BetaToolTextEditor20250124 struct{…}
Name StrReplaceEditor
Name StrReplaceEditor
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:
const StrReplaceEditorStrReplaceEditor StrReplaceEditor = "str_replace_editor"
Type TextEditor20250124
Type TextEditor20250124
Accepts one of the following:
const TextEditor20250124TextEditor20250124 TextEditor20250124 = "text_editor_20250124"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"
const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
InputExamples []map[string, any]optional
Strict booloptional
type BetaToolTextEditor20250429 struct{…}
type BetaToolTextEditor20250429 struct{…}
Name StrReplaceBasedEditTool
Name StrReplaceBasedEditTool
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:
const StrReplaceBasedEditToolStrReplaceBasedEditTool StrReplaceBasedEditTool = "str_replace_based_edit_tool"
Type TextEditor20250429
Type TextEditor20250429
Accepts one of the following:
const TextEditor20250429TextEditor20250429 TextEditor20250429 = "text_editor_20250429"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"
const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
InputExamples []map[string, any]optional
Strict booloptional
type BetaToolTextEditor20250728 struct{…}
type BetaToolTextEditor20250728 struct{…}
Name StrReplaceBasedEditTool
Name StrReplaceBasedEditTool
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:
const StrReplaceBasedEditToolStrReplaceBasedEditTool StrReplaceBasedEditTool = "str_replace_based_edit_tool"
Type TextEditor20250728
Type TextEditor20250728
Accepts one of the following:
const TextEditor20250728TextEditor20250728 TextEditor20250728 = "text_editor_20250728"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"
const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
InputExamples []map[string, any]optional
MaxCharacters int64optional
MaxCharacters int64optional
Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.
minimum1
Strict booloptional
type BetaWebSearchTool20250305 struct{…}
type BetaWebSearchTool20250305 struct{…}
Name WebSearch
Name WebSearch
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:
const WebSearchWebSearch WebSearch = "web_search"
Type WebSearch20250305
Type WebSearch20250305
Accepts one of the following:
const WebSearch20250305WebSearch20250305 WebSearch20250305 = "web_search_20250305"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"
const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"
AllowedDomains []stringoptional
AllowedDomains []stringoptional
If provided, only these domains will be included in results. Cannot be used alongside blocked_domains.
BlockedDomains []stringoptional
BlockedDomains []stringoptional
If provided, these domains will never appear in results. Cannot be used alongside allowed_domains.
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
MaxUses int64optional
MaxUses int64optional
Maximum number of times the tool can be used in the API request.
exclusiveMinimum0
Strict booloptional
UserLocation BetaWebSearchTool20250305UserLocationoptional
UserLocation BetaWebSearchTool20250305UserLocationoptional
Parameters for the user's location. Used to provide more relevant search results.
Type Approximate
Type Approximate
Accepts one of the following:
const ApproximateApproximate Approximate = "approximate"
City stringoptional
City stringoptional
The city of the user.
maxLength255
minLength1
Country stringoptional
Country stringoptional
The two letter ISO country code of the user.
maxLength2
minLength2
Region stringoptional
Region stringoptional
The region of the user.
maxLength255
minLength1
Timezone stringoptional
Timezone stringoptional
The IANA timezone of the user.
maxLength255
minLength1
type BetaWebFetchTool20250910 struct{…}
type BetaWebFetchTool20250910 struct{…}
Name WebFetch
Name WebFetch
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:
const WebFetchWebFetch WebFetch = "web_fetch"
Type WebFetch20250910
Type WebFetch20250910
Accepts one of the following:
const WebFetch20250910WebFetch20250910 WebFetch20250910 = "web_fetch_20250910"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"
const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"
AllowedDomains []stringoptional
AllowedDomains []stringoptional
List of domains to allow fetching from
BlockedDomains []stringoptional
BlockedDomains []stringoptional
List of domains to block fetching from
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Citations configuration for fetched documents. Citations are disabled by default.
Enabled booloptional
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
MaxContentTokens int64optional
MaxContentTokens int64optional
Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
exclusiveMinimum0
MaxUses int64optional
MaxUses int64optional
Maximum number of times the tool can be used in the API request.
exclusiveMinimum0
Strict booloptional
type BetaToolSearchToolBm25_20251119 struct{…}
type BetaToolSearchToolBm25_20251119 struct{…}
Name ToolSearchToolBm25
Name ToolSearchToolBm25
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:
const ToolSearchToolBm25ToolSearchToolBm25 ToolSearchToolBm25 = "tool_search_tool_bm25"
Type BetaToolSearchToolBm25_20251119Type
Type BetaToolSearchToolBm25_20251119Type
Accepts one of the following:
const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"
const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"
const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Strict booloptional
type BetaToolSearchToolRegex20251119 struct{…}
type BetaToolSearchToolRegex20251119 struct{…}
Name ToolSearchToolRegex
Name ToolSearchToolRegex
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:
const ToolSearchToolRegexToolSearchToolRegex ToolSearchToolRegex = "tool_search_tool_regex"
Type BetaToolSearchToolRegex20251119Type
Type BetaToolSearchToolRegex20251119Type
Accepts one of the following:
const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"
const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"
const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Strict booloptional
type BetaMCPToolset struct{…}
type BetaMCPToolset struct{…}
Configuration for a group of tools from an MCP server.
Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides.
MCPServerName string
MCPServerName string
Name of the MCP server to configure tools for
maxLength255
minLength1
Type MCPToolset
Type MCPToolset
Accepts one of the following:
const MCPToolsetMCPToolset MCPToolset = "mcp_toolset"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Configuration overrides for specific tools, keyed by tool name
DeferLoading booloptional
Enabled booloptional
Default configuration applied to all tools from this server
DeferLoading booloptional
Enabled booloptional
type BetaToolUseBlock struct{…}
type BetaToolUseBlock struct{…}
ID string
Input map[string, any]
Name string
Type ToolUse
Type ToolUse
Accepts one of the following:
const ToolUseToolUse ToolUse = "tool_use"
Caller BetaToolUseBlockCallerUnionoptional
Caller BetaToolUseBlockCallerUnionoptional
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
Type Direct
Accepts one of the following:
const DirectDirect Direct = "direct"
type BetaServerToolCaller struct{…}
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
type BetaToolUseBlockParamResp struct{…}
type BetaToolUseBlockParamResp struct{…}
ID string
Input map[string, any]
Name string
Type ToolUse
Type ToolUse
Accepts one of the following:
const ToolUseToolUse ToolUse = "tool_use"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Caller BetaToolUseBlockParamCallerUnionRespoptional
Caller BetaToolUseBlockParamCallerUnionRespoptional
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
Type Direct
Accepts one of the following:
const DirectDirect Direct = "direct"
type BetaServerToolCaller struct{…}
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
type BetaToolUsesKeep struct{…}
type BetaToolUsesKeep struct{…}
Type ToolUses
Type ToolUses
Accepts one of the following:
const ToolUsesToolUses ToolUses = "tool_uses"
Value int64
type BetaToolUsesTrigger struct{…}
type BetaToolUsesTrigger struct{…}
Type ToolUses
Type ToolUses
Accepts one of the following:
const ToolUsesToolUses ToolUses = "tool_uses"
Value int64
type BetaURLImageSource struct{…}
type BetaURLImageSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaURLPDFSource struct{…}
type BetaURLPDFSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaUsage struct{…}
type BetaUsage struct{…}
CacheCreation BetaCacheCreation
CacheCreation BetaCacheCreation
Breakdown of cached tokens by TTL
Ephemeral1hInputTokens int64
Ephemeral1hInputTokens int64
The number of input tokens used to create the 1 hour cache entry.
minimum0
Ephemeral5mInputTokens int64
Ephemeral5mInputTokens int64
The number of input tokens used to create the 5 minute cache entry.
minimum0
CacheCreationInputTokens int64
CacheCreationInputTokens int64
The number of input tokens used to create the cache entry.
minimum0
CacheReadInputTokens int64
CacheReadInputTokens int64
The number of input tokens read from the cache.
minimum0
InputTokens int64
InputTokens int64
The number of input tokens which were used.
minimum0
OutputTokens int64
OutputTokens int64
The number of output tokens which were used.
minimum0
ServerToolUse BetaServerToolUsage
ServerToolUse BetaServerToolUsage
The number of server tool requests.
WebFetchRequests int64
WebFetchRequests int64
The number of web fetch tool requests.
minimum0
WebSearchRequests int64
WebSearchRequests int64
The number of web search tool requests.
minimum0
ServiceTier BetaUsageServiceTier
ServiceTier BetaUsageServiceTier
If the request used the priority, standard, or batch tier.
Accepts one of the following:
const BetaUsageServiceTierStandard BetaUsageServiceTier = "standard"
const BetaUsageServiceTierPriority BetaUsageServiceTier = "priority"
const BetaUsageServiceTierBatch BetaUsageServiceTier = "batch"
type BetaWebFetchBlock struct{…}
type BetaWebFetchBlock struct{…}
Content BetaDocumentBlock
Content BetaDocumentBlock
Citations BetaCitationConfig
Citations BetaCitationConfig
Citation configuration for the document
Enabled bool
Source BetaDocumentBlockSourceUnion
Source BetaDocumentBlockSourceUnion
Accepts one of the following:
type BetaBase64PDFSource struct{…}
type BetaBase64PDFSource struct{…}
Data string
MediaType ApplicationPDF
MediaType ApplicationPDF
Accepts one of the following:
const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaPlainTextSource struct{…}
type BetaPlainTextSource struct{…}
Data string
MediaType TextPlain
MediaType TextPlain
Accepts one of the following:
const TextPlainTextPlain TextPlain = "text/plain"
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Title string
Title string
The title of the document
Type Document
Type Document
Accepts one of the following:
const DocumentDocument Document = "document"
RetrievedAt string
RetrievedAt string
ISO 8601 timestamp when the content was retrieved
Type WebFetchResult
Type WebFetchResult
Accepts one of the following:
const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"
URL string
URL string
Fetched content URL
type BetaWebFetchBlockParamResp struct{…}
type BetaWebFetchBlockParamResp struct{…}
Content BetaRequestDocumentBlock
Content BetaRequestDocumentBlock
Source BetaRequestDocumentBlockSourceUnion
Source BetaRequestDocumentBlockSourceUnion
Accepts one of the following:
type BetaBase64PDFSource struct{…}
type BetaBase64PDFSource struct{…}
Data string
MediaType ApplicationPDF
MediaType ApplicationPDF
Accepts one of the following:
const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaPlainTextSource struct{…}
type BetaPlainTextSource struct{…}
Data string
MediaType TextPlain
MediaType TextPlain
Accepts one of the following:
const TextPlainTextPlain TextPlain = "text/plain"
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
type BetaContentBlockSource struct{…}
type BetaContentBlockSource struct{…}
Content BetaContentBlockSourceContentUnion
Content BetaContentBlockSourceContentUnion
Accepts one of the following:
string
Accepts one of the following:
type BetaTextBlockParamResp struct{…}
type BetaTextBlockParamResp struct{…}
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
type BetaImageBlockParamResp struct{…}
type BetaImageBlockParamResp struct{…}
Source BetaImageBlockParamSourceUnionResp
Source BetaImageBlockParamSourceUnionResp
Accepts one of the following:
type BetaBase64ImageSource struct{…}
type BetaBase64ImageSource struct{…}
Data string
MediaType BetaBase64ImageSourceMediaType
MediaType BetaBase64ImageSourceMediaType
Accepts one of the following:
const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"
const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"
const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"
const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaURLImageSource struct{…}
type BetaURLImageSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileImageSource struct{…}
type BetaFileImageSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Image
Type Image
Accepts one of the following:
const ImageImage Image = "image"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Type Content
Type Content
Accepts one of the following:
const ContentContent Content = "content"
type BetaURLPDFSource struct{…}
type BetaURLPDFSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileDocumentSource struct{…}
type BetaFileDocumentSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Document
Type Document
Accepts one of the following:
const DocumentDocument Document = "document"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Enabled booloptional
Context stringoptional
Title stringoptional
Type WebFetchResult
Type WebFetchResult
Accepts one of the following:
const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"
URL string
URL string
Fetched content URL
RetrievedAt stringoptional
RetrievedAt stringoptional
ISO 8601 timestamp when the content was retrieved
type BetaWebFetchTool20250910 struct{…}
type BetaWebFetchTool20250910 struct{…}
Name WebFetch
Name WebFetch
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:
const WebFetchWebFetch WebFetch = "web_fetch"
Type WebFetch20250910
Type WebFetch20250910
Accepts one of the following:
const WebFetch20250910WebFetch20250910 WebFetch20250910 = "web_fetch_20250910"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"
const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"
AllowedDomains []stringoptional
AllowedDomains []stringoptional
List of domains to allow fetching from
BlockedDomains []stringoptional
BlockedDomains []stringoptional
List of domains to block fetching from
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Citations configuration for fetched documents. Citations are disabled by default.
Enabled booloptional
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
MaxContentTokens int64optional
MaxContentTokens int64optional
Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
exclusiveMinimum0
MaxUses int64optional
MaxUses int64optional
Maximum number of times the tool can be used in the API request.
exclusiveMinimum0
Strict booloptional
type BetaWebFetchToolResultBlock struct{…}
type BetaWebFetchToolResultBlock struct{…}
Content BetaWebFetchToolResultBlockContentUnion
Content BetaWebFetchToolResultBlockContentUnion
Accepts one of the following:
type BetaWebFetchToolResultErrorBlock struct{…}
type BetaWebFetchToolResultErrorBlock struct{…}
ErrorCode BetaWebFetchToolResultErrorCode
ErrorCode BetaWebFetchToolResultErrorCode
Accepts one of the following:
const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"
const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"
const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"
const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"
const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"
const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"
Type WebFetchToolResultError
Type WebFetchToolResultError
Accepts one of the following:
const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"
type BetaWebFetchBlock struct{…}
type BetaWebFetchBlock struct{…}
Content BetaDocumentBlock
Content BetaDocumentBlock
Citations BetaCitationConfig
Citations BetaCitationConfig
Citation configuration for the document
Enabled bool
Source BetaDocumentBlockSourceUnion
Source BetaDocumentBlockSourceUnion
Accepts one of the following:
type BetaBase64PDFSource struct{…}
type BetaBase64PDFSource struct{…}
Data string
MediaType ApplicationPDF
MediaType ApplicationPDF
Accepts one of the following:
const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaPlainTextSource struct{…}
type BetaPlainTextSource struct{…}
Data string
MediaType TextPlain
MediaType TextPlain
Accepts one of the following:
const TextPlainTextPlain TextPlain = "text/plain"
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Title string
Title string
The title of the document
Type Document
Type Document
Accepts one of the following:
const DocumentDocument Document = "document"
RetrievedAt string
RetrievedAt string
ISO 8601 timestamp when the content was retrieved
Type WebFetchResult
Type WebFetchResult
Accepts one of the following:
const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"
URL string
URL string
Fetched content URL
ToolUseID string
Type WebFetchToolResult
Type WebFetchToolResult
Accepts one of the following:
const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"
type BetaWebFetchToolResultBlockParamResp struct{…}
type BetaWebFetchToolResultBlockParamResp struct{…}
Content BetaWebFetchToolResultBlockParamContentUnionResp
Content BetaWebFetchToolResultBlockParamContentUnionResp
Accepts one of the following:
type BetaWebFetchToolResultErrorBlockParamResp struct{…}
type BetaWebFetchToolResultErrorBlockParamResp struct{…}
ErrorCode BetaWebFetchToolResultErrorCode
ErrorCode BetaWebFetchToolResultErrorCode
Accepts one of the following:
const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"
const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"
const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"
const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"
const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"
const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"
Type WebFetchToolResultError
Type WebFetchToolResultError
Accepts one of the following:
const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"
type BetaWebFetchBlockParamResp struct{…}
type BetaWebFetchBlockParamResp struct{…}
Content BetaRequestDocumentBlock
Content BetaRequestDocumentBlock
Source BetaRequestDocumentBlockSourceUnion
Source BetaRequestDocumentBlockSourceUnion
Accepts one of the following:
type BetaBase64PDFSource struct{…}
type BetaBase64PDFSource struct{…}
Data string
MediaType ApplicationPDF
MediaType ApplicationPDF
Accepts one of the following:
const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaPlainTextSource struct{…}
type BetaPlainTextSource struct{…}
Data string
MediaType TextPlain
MediaType TextPlain
Accepts one of the following:
const TextPlainTextPlain TextPlain = "text/plain"
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
type BetaContentBlockSource struct{…}
type BetaContentBlockSource struct{…}
Content BetaContentBlockSourceContentUnion
Content BetaContentBlockSourceContentUnion
Accepts one of the following:
string
Accepts one of the following:
type BetaTextBlockParamResp struct{…}
type BetaTextBlockParamResp struct{…}
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
type BetaImageBlockParamResp struct{…}
type BetaImageBlockParamResp struct{…}
Source BetaImageBlockParamSourceUnionResp
Source BetaImageBlockParamSourceUnionResp
Accepts one of the following:
type BetaBase64ImageSource struct{…}
type BetaBase64ImageSource struct{…}
Data string
MediaType BetaBase64ImageSourceMediaType
MediaType BetaBase64ImageSourceMediaType
Accepts one of the following:
const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"
const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"
const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"
const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaURLImageSource struct{…}
type BetaURLImageSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileImageSource struct{…}
type BetaFileImageSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Image
Type Image
Accepts one of the following:
const ImageImage Image = "image"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Type Content
Type Content
Accepts one of the following:
const ContentContent Content = "content"
type BetaURLPDFSource struct{…}
type BetaURLPDFSource struct{…}
Type URL
Type URL
Accepts one of the following:
const URLURL URL = "url"
URL string
type BetaFileDocumentSource struct{…}
type BetaFileDocumentSource struct{…}
FileID string
Type File
Type File
Accepts one of the following:
const FileFile File = "file"
Type Document
Type Document
Accepts one of the following:
const DocumentDocument Document = "document"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
Enabled booloptional
Context stringoptional
Title stringoptional
Type WebFetchResult
Type WebFetchResult
Accepts one of the following:
const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"
URL string
URL string
Fetched content URL
RetrievedAt stringoptional
RetrievedAt stringoptional
ISO 8601 timestamp when the content was retrieved
ToolUseID string
Type WebFetchToolResult
Type WebFetchToolResult
Accepts one of the following:
const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaWebFetchToolResultErrorBlock struct{…}
type BetaWebFetchToolResultErrorBlock struct{…}
ErrorCode BetaWebFetchToolResultErrorCode
ErrorCode BetaWebFetchToolResultErrorCode
Accepts one of the following:
const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"
const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"
const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"
const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"
const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"
const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"
Type WebFetchToolResultError
Type WebFetchToolResultError
Accepts one of the following:
const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"
type BetaWebFetchToolResultErrorBlockParamResp struct{…}
type BetaWebFetchToolResultErrorBlockParamResp struct{…}
ErrorCode BetaWebFetchToolResultErrorCode
ErrorCode BetaWebFetchToolResultErrorCode
Accepts one of the following:
const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"
const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"
const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"
const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"
const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"
const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"
Type WebFetchToolResultError
Type WebFetchToolResultError
Accepts one of the following:
const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"
type BetaWebFetchToolResultErrorCode string
type BetaWebFetchToolResultErrorCode string
Accepts one of the following:
const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"
const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"
const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"
const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"
const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"
const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"
type BetaWebSearchResultBlock struct{…}
type BetaWebSearchResultBlock struct{…}
EncryptedContent string
PageAge string
Title string
Type WebSearchResult
Type WebSearchResult
Accepts one of the following:
const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"
URL string
type BetaWebSearchResultBlockParamResp struct{…}
type BetaWebSearchResultBlockParamResp struct{…}
EncryptedContent string
Title string
Type WebSearchResult
Type WebSearchResult
Accepts one of the following:
const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"
URL string
PageAge stringoptional
type BetaWebSearchTool20250305 struct{…}
type BetaWebSearchTool20250305 struct{…}
Name WebSearch
Name WebSearch
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:
const WebSearchWebSearch WebSearch = "web_search"
Type WebSearch20250305
Type WebSearch20250305
Accepts one of the following:
const WebSearch20250305WebSearch20250305 WebSearch20250305 = "web_search_20250305"
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"
const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"
AllowedDomains []stringoptional
AllowedDomains []stringoptional
If provided, only these domains will be included in results. Cannot be used alongside blocked_domains.
BlockedDomains []stringoptional
BlockedDomains []stringoptional
If provided, these domains will never appear in results. Cannot be used alongside allowed_domains.
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
DeferLoading booloptional
DeferLoading booloptional
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
MaxUses int64optional
MaxUses int64optional
Maximum number of times the tool can be used in the API request.
exclusiveMinimum0
Strict booloptional
UserLocation BetaWebSearchTool20250305UserLocationoptional
UserLocation BetaWebSearchTool20250305UserLocationoptional
Parameters for the user's location. Used to provide more relevant search results.
Type Approximate
Type Approximate
Accepts one of the following:
const ApproximateApproximate Approximate = "approximate"
City stringoptional
City stringoptional
The city of the user.
maxLength255
minLength1
Country stringoptional
Country stringoptional
The two letter ISO country code of the user.
maxLength2
minLength2
Region stringoptional
Region stringoptional
The region of the user.
maxLength255
minLength1
Timezone stringoptional
Timezone stringoptional
The IANA timezone of the user.
maxLength255
minLength1
type BetaWebSearchToolRequestError struct{…}
type BetaWebSearchToolRequestError struct{…}
ErrorCode BetaWebSearchToolResultErrorCode
ErrorCode BetaWebSearchToolResultErrorCode
Accepts one of the following:
const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"
const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"
const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"
const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"
Type WebSearchToolResultError
Type WebSearchToolResultError
Accepts one of the following:
const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"
type BetaWebSearchToolResultBlock struct{…}
type BetaWebSearchToolResultBlock struct{…}
Accepts one of the following:
type BetaWebSearchToolResultError struct{…}
type BetaWebSearchToolResultError struct{…}
ErrorCode BetaWebSearchToolResultErrorCode
ErrorCode BetaWebSearchToolResultErrorCode
Accepts one of the following:
const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"
const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"
const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"
const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"
Type WebSearchToolResultError
Type WebSearchToolResultError
Accepts one of the following:
const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"
EncryptedContent string
PageAge string
Title string
Type WebSearchResult
Type WebSearchResult
Accepts one of the following:
const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"
URL string
ToolUseID string
Type WebSearchToolResult
Type WebSearchToolResult
Accepts one of the following:
const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"
type BetaWebSearchToolResultBlockContentUnion interface{…}
type BetaWebSearchToolResultBlockContentUnion interface{…}
Accepts one of the following:
type BetaWebSearchToolResultError struct{…}
type BetaWebSearchToolResultError struct{…}
ErrorCode BetaWebSearchToolResultErrorCode
ErrorCode BetaWebSearchToolResultErrorCode
Accepts one of the following:
const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"
const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"
const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"
const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"
Type WebSearchToolResultError
Type WebSearchToolResultError
Accepts one of the following:
const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"
EncryptedContent string
PageAge string
Title string
Type WebSearchResult
Type WebSearchResult
Accepts one of the following:
const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"
URL string
type BetaWebSearchToolResultBlockParamResp struct{…}
type BetaWebSearchToolResultBlockParamResp struct{…}
Accepts one of the following:
EncryptedContent string
Title string
Type WebSearchResult
Type WebSearchResult
Accepts one of the following:
const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"
URL string
PageAge stringoptional
type BetaWebSearchToolRequestError struct{…}
type BetaWebSearchToolRequestError struct{…}
ErrorCode BetaWebSearchToolResultErrorCode
ErrorCode BetaWebSearchToolResultErrorCode
Accepts one of the following:
const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"
const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"
const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"
const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"
Type WebSearchToolResultError
Type WebSearchToolResultError
Accepts one of the following:
const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"
ToolUseID string
Type WebSearchToolResult
Type WebSearchToolResult
Accepts one of the following:
const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"
Create a cache control breakpoint at this content block.
Type Ephemeral
Type Ephemeral
Accepts one of the following:
const EphemeralEphemeral Ephemeral = "ephemeral"
TTL BetaCacheControlEphemeralTTLoptional
TTL BetaCacheControlEphemeralTTLoptional
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Accepts one of the following:
const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"
const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"
type BetaWebSearchToolResultBlockParamContentUnionResp interface{…}
type BetaWebSearchToolResultBlockParamContentUnionResp interface{…}
Accepts one of the following:
EncryptedContent string
Title string
Type WebSearchResult
Type WebSearchResult
Accepts one of the following:
const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"
URL string
PageAge stringoptional
type BetaWebSearchToolRequestError struct{…}
type BetaWebSearchToolRequestError struct{…}
ErrorCode BetaWebSearchToolResultErrorCode
ErrorCode BetaWebSearchToolResultErrorCode
Accepts one of the following:
const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"
const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"
const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"
const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"
Type WebSearchToolResultError
Type WebSearchToolResultError
Accepts one of the following:
const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"
type BetaWebSearchToolResultError struct{…}
type BetaWebSearchToolResultError struct{…}
ErrorCode BetaWebSearchToolResultErrorCode
ErrorCode BetaWebSearchToolResultErrorCode
Accepts one of the following:
const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"
const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"
const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"
const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"
Type WebSearchToolResultError
Type WebSearchToolResultError
Accepts one of the following:
const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"
type BetaWebSearchToolResultErrorCode string
type BetaWebSearchToolResultErrorCode string
Accepts one of the following:
const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"
const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"
const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"
const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"
MessagesBatches
Create a Message Batch
client.Beta.Messages.Batches.New(ctx, params) (*BetaMessageBatch, error)
post/v1/messages/batches
Retrieve a Message Batch
client.Beta.Messages.Batches.Get(ctx, messageBatchID, query) (*BetaMessageBatch, error)
get/v1/messages/batches/{message_batch_id}
List Message Batches
client.Beta.Messages.Batches.List(ctx, params) (*Page[BetaMessageBatch], error)
get/v1/messages/batches
Cancel a Message Batch
client.Beta.Messages.Batches.Cancel(ctx, messageBatchID, body) (*BetaMessageBatch, error)
post/v1/messages/batches/{message_batch_id}/cancel
Delete a Message Batch
client.Beta.Messages.Batches.Delete(ctx, messageBatchID, body) (*BetaDeletedMessageBatch, error)
delete/v1/messages/batches/{message_batch_id}
Retrieve Message Batch results
client.Beta.Messages.Batches.Results(ctx, messageBatchID, query) (*BetaMessageBatchIndividualResponse, error)
get/v1/messages/batches/{message_batch_id}/results
ModelsExpand Collapse
type BetaDeletedMessageBatch struct{…}
type BetaDeletedMessageBatch struct{…}
ID string
ID string
ID of the Message Batch.
Type MessageBatchDeleted
Type MessageBatchDeleted
Deleted object type.
For Message Batches, this is always "message_batch_deleted".
Accepts one of the following:
const MessageBatchDeletedMessageBatchDeleted MessageBatchDeleted = "message_batch_deleted"
type BetaMessageBatch struct{…}
type BetaMessageBatch struct{…}
ID string
ID string
Unique object identifier.
The format and length of IDs may change over time.
ArchivedAt Time
ArchivedAt Time
RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.
formatdate-time
CancelInitiatedAt Time
CancelInitiatedAt Time
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 Time
CreatedAt Time
RFC 3339 datetime string representing the time at which the Message Batch was created.
formatdate-time
EndedAt Time
EndedAt Time
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 Time
ExpiresAt Time
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 BetaMessageBatchProcessingStatus
ProcessingStatus BetaMessageBatchProcessingStatus
Processing status of the Message Batch.
Accepts one of the following:
const BetaMessageBatchProcessingStatusInProgress BetaMessageBatchProcessingStatus = "in_progress"
const BetaMessageBatchProcessingStatusCanceling BetaMessageBatchProcessingStatus = "canceling"
const BetaMessageBatchProcessingStatusEnded BetaMessageBatchProcessingStatus = "ended"
RequestCounts BetaMessageBatchRequestCounts
RequestCounts BetaMessageBatchRequestCounts
Tallies requests within the Message Batch, categorized by their status.
Requests start as processing and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch.
Canceled int64
Canceled int64
Number of requests in the Message Batch that have been canceled.
This is zero until processing of the entire Message Batch has ended.
Errored int64
Errored int64
Number of requests in the Message Batch that encountered an error.
This is zero until processing of the entire Message Batch has ended.
Expired int64
Expired int64
Number of requests in the Message Batch that have expired.
This is zero until processing of the entire Message Batch has ended.
Processing int64
Processing int64
Number of requests in the Message Batch that are processing.
Succeeded int64
Succeeded int64
Number of requests in the Message Batch that have completed successfully.
This is zero until processing of the entire Message Batch has ended.
ResultsURL string
ResultsURL 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 MessageBatch
Type MessageBatch
Object type.
For Message Batches, this is always "message_batch".
Accepts one of the following:
const MessageBatchMessageBatch MessageBatch = "message_batch"
type BetaMessageBatchCanceledResult struct{…}
type BetaMessageBatchCanceledResult struct{…}
Type Canceled
Type Canceled
Accepts one of the following:
const CanceledCanceled Canceled = "canceled"
type BetaMessageBatchErroredResult struct{…}
type BetaMessageBatchErroredResult struct{…}
Error BetaErrorResponse
Error BetaErrorResponse
Error BetaErrorUnion
Error BetaErrorUnion
Accepts one of the following:
type BetaInvalidRequestError struct{…}
type BetaInvalidRequestError struct{…}
Message string
Type InvalidRequestError
Type InvalidRequestError
Accepts one of the following:
const InvalidRequestErrorInvalidRequestError InvalidRequestError = "invalid_request_error"
type BetaAuthenticationError struct{…}
type BetaAuthenticationError struct{…}
Message string
Type AuthenticationError
Type AuthenticationError
Accepts one of the following:
const AuthenticationErrorAuthenticationError AuthenticationError = "authentication_error"
type BetaBillingError struct{…}
type BetaBillingError struct{…}
Message string
Type BillingError
Type BillingError
Accepts one of the following:
const BillingErrorBillingError BillingError = "billing_error"
type BetaPermissionError struct{…}
type BetaPermissionError struct{…}
Message string
Type PermissionError
Type PermissionError
Accepts one of the following:
const PermissionErrorPermissionError PermissionError = "permission_error"
type BetaNotFoundError struct{…}
type BetaNotFoundError struct{…}
Message string
Type NotFoundError
Type NotFoundError
Accepts one of the following:
const NotFoundErrorNotFoundError NotFoundError = "not_found_error"
type BetaRateLimitError struct{…}
type BetaRateLimitError struct{…}
Message string
Type RateLimitError
Type RateLimitError
Accepts one of the following:
const RateLimitErrorRateLimitError RateLimitError = "rate_limit_error"
type BetaGatewayTimeoutError struct{…}
type BetaGatewayTimeoutError struct{…}
Message string
Type TimeoutError
Type TimeoutError
Accepts one of the following:
const TimeoutErrorTimeoutError TimeoutError = "timeout_error"
type BetaAPIError struct{…}
type BetaAPIError struct{…}
Message string
Type APIError
Type APIError
Accepts one of the following:
const APIErrorAPIError APIError = "api_error"
type BetaOverloadedError struct{…}
type BetaOverloadedError struct{…}
Message string
Type OverloadedError
Type OverloadedError
Accepts one of the following:
const OverloadedErrorOverloadedError OverloadedError = "overloaded_error"
RequestID string
Type Error
Type Error
Accepts one of the following:
const ErrorError Error = "error"
Type Errored
Type Errored
Accepts one of the following:
const ErroredErrored Errored = "errored"
type BetaMessageBatchExpiredResult struct{…}
type BetaMessageBatchExpiredResult struct{…}
Type Expired
Type Expired
Accepts one of the following:
const ExpiredExpired Expired = "expired"
type BetaMessageBatchIndividualResponse struct{…}
type BetaMessageBatchIndividualResponse struct{…}
This is a single line in the response .jsonl file and does not represent the response as a whole.
CustomID string
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 BetaMessageBatchResultUnion
Result BetaMessageBatchResultUnion
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:
type BetaMessageBatchSucceededResult struct{…}
type BetaMessageBatchSucceededResult struct{…}
Message BetaMessage
Message BetaMessage
ID string
ID string
Unique object identifier.
The format and length of IDs may change over time.
Container BetaContainer
Container BetaContainer
Information about the container used in the request (for the code execution tool)
ID string
ID string
Identifier for the container used in this request
ExpiresAt Time
ExpiresAt Time
The time at which the container will expire.
formatdate-time
Skills []BetaSkill
Skills []BetaSkill
Skills loaded in the container
SkillID string
SkillID string
Skill ID
maxLength64
minLength1
Type BetaSkillType
Type BetaSkillType
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Accepts one of the following:
const BetaSkillTypeAnthropic BetaSkillType = "anthropic"
const BetaSkillTypeCustom BetaSkillType = "custom"
Version string
Version string
Skill version or 'latest' for most recent version
maxLength64
minLength1
Content []BetaContentBlockUnion
Content []BetaContentBlockUnion
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:
type BetaTextBlock struct{…}
type BetaTextBlock struct{…}
Citations []BetaTextCitationUnion
Citations []BetaTextCitationUnion
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
Accepts one of the following:
type BetaCitationCharLocation struct{…}
type BetaCitationCharLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
FileID string
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
type BetaThinkingBlock struct{…}
type BetaThinkingBlock struct{…}
Signature string
Thinking string
Type Thinking
Type Thinking
Accepts one of the following:
const ThinkingThinking Thinking = "thinking"
type BetaRedactedThinkingBlock struct{…}
type BetaRedactedThinkingBlock struct{…}
Data string
Type RedactedThinking
Type RedactedThinking
Accepts one of the following:
const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"
type BetaToolUseBlock struct{…}
type BetaToolUseBlock struct{…}
ID string
Input map[string, any]
Name string
Type ToolUse
Type ToolUse
Accepts one of the following:
const ToolUseToolUse ToolUse = "tool_use"
Caller BetaToolUseBlockCallerUnionoptional
Caller BetaToolUseBlockCallerUnionoptional
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
Type Direct
Accepts one of the following:
const DirectDirect Direct = "direct"
type BetaServerToolCaller struct{…}
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
type BetaServerToolUseBlock struct{…}
type BetaServerToolUseBlock struct{…}
ID string
Caller BetaServerToolUseBlockCallerUnion
Caller BetaServerToolUseBlockCallerUnion
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
Type Direct
Accepts one of the following:
const DirectDirect Direct = "direct"
type BetaServerToolCaller struct{…}
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
Input map[string, any]
Name BetaServerToolUseBlockName
Name BetaServerToolUseBlockName
Accepts one of the following:
const BetaServerToolUseBlockNameWebSearch BetaServerToolUseBlockName = "web_search"
const BetaServerToolUseBlockNameWebFetch BetaServerToolUseBlockName = "web_fetch"
const BetaServerToolUseBlockNameCodeExecution BetaServerToolUseBlockName = "code_execution"
const BetaServerToolUseBlockNameBashCodeExecution BetaServerToolUseBlockName = "bash_code_execution"
const BetaServerToolUseBlockNameTextEditorCodeExecution BetaServerToolUseBlockName = "text_editor_code_execution"
const BetaServerToolUseBlockNameToolSearchToolRegex BetaServerToolUseBlockName = "tool_search_tool_regex"
const BetaServerToolUseBlockNameToolSearchToolBm25 BetaServerToolUseBlockName = "tool_search_tool_bm25"
Type ServerToolUse
Type ServerToolUse
Accepts one of the following:
const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"
type BetaWebSearchToolResultBlock struct{…}
type BetaWebSearchToolResultBlock struct{…}
Accepts one of the following:
type BetaWebSearchToolResultError struct{…}
type BetaWebSearchToolResultError struct{…}
ErrorCode BetaWebSearchToolResultErrorCode
ErrorCode BetaWebSearchToolResultErrorCode
Accepts one of the following:
const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"
const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"
const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"
const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"
Type WebSearchToolResultError
Type WebSearchToolResultError
Accepts one of the following:
const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"
EncryptedContent string
PageAge string
Title string
Type WebSearchResult
Type WebSearchResult
Accepts one of the following:
const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"
URL string
ToolUseID string
Type WebSearchToolResult
Type WebSearchToolResult
Accepts one of the following:
const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"
type BetaWebFetchToolResultBlock struct{…}
type BetaWebFetchToolResultBlock struct{…}
Content BetaWebFetchToolResultBlockContentUnion
Content BetaWebFetchToolResultBlockContentUnion
Accepts one of the following:
type BetaWebFetchToolResultErrorBlock struct{…}
type BetaWebFetchToolResultErrorBlock struct{…}
ErrorCode BetaWebFetchToolResultErrorCode
ErrorCode BetaWebFetchToolResultErrorCode
Accepts one of the following:
const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"
const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"
const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"
const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"
const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"
const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"
Type WebFetchToolResultError
Type WebFetchToolResultError
Accepts one of the following:
const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"
type BetaWebFetchBlock struct{…}
type BetaWebFetchBlock struct{…}
Content BetaDocumentBlock
Content BetaDocumentBlock
Citations BetaCitationConfig
Citations BetaCitationConfig
Citation configuration for the document
Enabled bool
Source BetaDocumentBlockSourceUnion
Source BetaDocumentBlockSourceUnion
Accepts one of the following:
type BetaBase64PDFSource struct{…}
type BetaBase64PDFSource struct{…}
Data string
MediaType ApplicationPDF
MediaType ApplicationPDF
Accepts one of the following:
const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaPlainTextSource struct{…}
type BetaPlainTextSource struct{…}
Data string
MediaType TextPlain
MediaType TextPlain
Accepts one of the following:
const TextPlainTextPlain TextPlain = "text/plain"
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Title string
Title string
The title of the document
Type Document
Type Document
Accepts one of the following:
const DocumentDocument Document = "document"
RetrievedAt string
RetrievedAt string
ISO 8601 timestamp when the content was retrieved
Type WebFetchResult
Type WebFetchResult
Accepts one of the following:
const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"
URL string
URL string
Fetched content URL
ToolUseID string
Type WebFetchToolResult
Type WebFetchToolResult
Accepts one of the following:
const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"
type BetaCodeExecutionToolResultBlock struct{…}
type BetaCodeExecutionToolResultBlock struct{…}
Accepts one of the following:
type BetaCodeExecutionToolResultError struct{…}
type BetaCodeExecutionToolResultError struct{…}
ErrorCode BetaCodeExecutionToolResultErrorCode
ErrorCode BetaCodeExecutionToolResultErrorCode
Accepts one of the following:
const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"
const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"
const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"
const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"
Type CodeExecutionToolResultError
Type CodeExecutionToolResultError
Accepts one of the following:
const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"
type BetaCodeExecutionResultBlock struct{…}
type BetaCodeExecutionResultBlock struct{…}
Content []BetaCodeExecutionOutputBlock
Content []BetaCodeExecutionOutputBlock
FileID string
Type CodeExecutionOutput
Type CodeExecutionOutput
Accepts one of the following:
const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type CodeExecutionResult
Type CodeExecutionResult
Accepts one of the following:
const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"
ToolUseID string
Type CodeExecutionToolResult
Type CodeExecutionToolResult
Accepts one of the following:
const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"
type BetaBashCodeExecutionToolResultBlock struct{…}
type BetaBashCodeExecutionToolResultBlock struct{…}
Content BetaBashCodeExecutionToolResultBlockContentUnion
Content BetaBashCodeExecutionToolResultBlockContentUnion
Accepts one of the following:
type BetaBashCodeExecutionToolResultError struct{…}
type BetaBashCodeExecutionToolResultError struct{…}
ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode
ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode
Accepts one of the following:
const BetaBashCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"
const BetaBashCodeExecutionToolResultErrorErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorErrorCode = "unavailable"
const BetaBashCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorErrorCode = "too_many_requests"
const BetaBashCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"
const BetaBashCodeExecutionToolResultErrorErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorErrorCode = "output_file_too_large"
Type BashCodeExecutionToolResultError
Type BashCodeExecutionToolResultError
Accepts one of the following:
const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"
type BetaBashCodeExecutionResultBlock struct{…}
type BetaBashCodeExecutionResultBlock struct{…}
Content []BetaBashCodeExecutionOutputBlock
Content []BetaBashCodeExecutionOutputBlock
FileID string
Type BashCodeExecutionOutput
Type BashCodeExecutionOutput
Accepts one of the following:
const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type BashCodeExecutionResult
Type BashCodeExecutionResult
Accepts one of the following:
const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"
ToolUseID string
Type BashCodeExecutionToolResult
Type BashCodeExecutionToolResult
Accepts one of the following:
const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"
type BetaTextEditorCodeExecutionToolResultBlock struct{…}
type BetaTextEditorCodeExecutionToolResultBlock struct{…}
Content BetaTextEditorCodeExecutionToolResultBlockContentUnion
Content BetaTextEditorCodeExecutionToolResultBlockContentUnion
Accepts one of the following:
type BetaTextEditorCodeExecutionToolResultError struct{…}
type BetaTextEditorCodeExecutionToolResultError struct{…}
ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode
ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode
Accepts one of the following:
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorErrorCode = "unavailable"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorErrorCode = "too_many_requests"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorErrorCode = "file_not_found"
ErrorMessage string
Type TextEditorCodeExecutionToolResultError
Type TextEditorCodeExecutionToolResultError
Accepts one of the following:
const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"
type BetaTextEditorCodeExecutionViewResultBlock struct{…}
type BetaTextEditorCodeExecutionViewResultBlock struct{…}
Content string
FileType BetaTextEditorCodeExecutionViewResultBlockFileType
FileType BetaTextEditorCodeExecutionViewResultBlockFileType
Accepts one of the following:
const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"
const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"
const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"
NumLines int64
StartLine int64
TotalLines int64
Type TextEditorCodeExecutionViewResult
Type TextEditorCodeExecutionViewResult
Accepts one of the following:
const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"
type BetaTextEditorCodeExecutionCreateResultBlock struct{…}
type BetaTextEditorCodeExecutionCreateResultBlock struct{…}
IsFileUpdate bool
Type TextEditorCodeExecutionCreateResult
Type TextEditorCodeExecutionCreateResult
Accepts one of the following:
const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"
type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}
type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}
Lines []string
NewLines int64
NewStart int64
OldLines int64
OldStart int64
Type TextEditorCodeExecutionStrReplaceResult
Type TextEditorCodeExecutionStrReplaceResult
Accepts one of the following:
const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"
ToolUseID string
Type TextEditorCodeExecutionToolResult
Type TextEditorCodeExecutionToolResult
Accepts one of the following:
const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"
type BetaToolSearchToolResultBlock struct{…}
type BetaToolSearchToolResultBlock struct{…}
Content BetaToolSearchToolResultBlockContentUnion
Content BetaToolSearchToolResultBlockContentUnion
Accepts one of the following:
type BetaToolSearchToolResultError struct{…}
type BetaToolSearchToolResultError struct{…}
ErrorCode BetaToolSearchToolResultErrorErrorCode
ErrorCode BetaToolSearchToolResultErrorErrorCode
Accepts one of the following:
const BetaToolSearchToolResultErrorErrorCodeInvalidToolInput BetaToolSearchToolResultErrorErrorCode = "invalid_tool_input"
const BetaToolSearchToolResultErrorErrorCodeUnavailable BetaToolSearchToolResultErrorErrorCode = "unavailable"
const BetaToolSearchToolResultErrorErrorCodeTooManyRequests BetaToolSearchToolResultErrorErrorCode = "too_many_requests"
const BetaToolSearchToolResultErrorErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorErrorCode = "execution_time_exceeded"
ErrorMessage string
Type ToolSearchToolResultError
Type ToolSearchToolResultError
Accepts one of the following:
const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"
type BetaToolSearchToolSearchResultBlock struct{…}
type BetaToolSearchToolSearchResultBlock struct{…}
ToolReferences []BetaToolReferenceBlock
ToolReferences []BetaToolReferenceBlock
ToolName string
Type ToolReference
Type ToolReference
Accepts one of the following:
const ToolReferenceToolReference ToolReference = "tool_reference"
Type ToolSearchToolSearchResult
Type ToolSearchToolSearchResult
Accepts one of the following:
const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"
ToolUseID string
Type ToolSearchToolResult
Type ToolSearchToolResult
Accepts one of the following:
const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"
type BetaMCPToolUseBlock struct{…}
type BetaMCPToolUseBlock struct{…}
ID string
Input map[string, any]
Name string
Name string
The name of the MCP tool
ServerName string
ServerName string
The name of the MCP server
Type MCPToolUse
Type MCPToolUse
Accepts one of the following:
const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"
type BetaMCPToolResultBlock struct{…}
type BetaMCPToolResultBlock struct{…}
Content BetaMCPToolResultBlockContentUnion
Content BetaMCPToolResultBlockContentUnion
Accepts one of the following:
string
Citations []BetaTextCitationUnion
Citations []BetaTextCitationUnion
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
Accepts one of the following:
type BetaCitationCharLocation struct{…}
type BetaCitationCharLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
FileID string
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
IsError bool
ToolUseID string
Type MCPToolResult
Type MCPToolResult
Accepts one of the following:
const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"
type BetaContainerUploadBlock struct{…}
type BetaContainerUploadBlock struct{…}
Response model for a file uploaded to the container.
FileID string
Type ContainerUpload
Type ContainerUpload
Accepts one of the following:
const ContainerUploadContainerUpload ContainerUpload = "container_upload"
ContextManagement BetaContextManagementResponse
ContextManagement BetaContextManagementResponse
Context management response.
Information about context management strategies applied during the request.
AppliedEdits []BetaContextManagementResponseAppliedEditUnion
AppliedEdits []BetaContextManagementResponseAppliedEditUnion
List of context management edits that were applied.
Accepts one of the following:
type BetaClearToolUses20250919EditResponse struct{…}
type BetaClearToolUses20250919EditResponse struct{…}
ClearedInputTokens int64
ClearedInputTokens int64
Number of input tokens cleared by this edit.
minimum0
ClearedToolUses int64
ClearedToolUses int64
Number of tool uses that were cleared.
minimum0
Type ClearToolUses20250919
Type ClearToolUses20250919
The type of context management edit applied.
Accepts one of the following:
const ClearToolUses20250919ClearToolUses20250919 ClearToolUses20250919 = "clear_tool_uses_20250919"
type BetaClearThinking20251015EditResponse struct{…}
type BetaClearThinking20251015EditResponse struct{…}
ClearedInputTokens int64
ClearedInputTokens int64
Number of input tokens cleared by this edit.
minimum0
ClearedThinkingTurns int64
ClearedThinkingTurns int64
Number of thinking turns that were cleared.
minimum0
Type ClearThinking20251015
Type ClearThinking20251015
The type of context management edit applied.
Accepts one of the following:
const ClearThinking20251015ClearThinking20251015 ClearThinking20251015 = "clear_thinking_20251015"
Model Model
Model Model
The model that will complete your prompt.
See models for additional details and options.
Accepts one of the following:
type Model string
type Model string
The model that will complete your prompt.
See models for additional details and options.
Accepts one of the following:
const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"
const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"
Premium model combining maximum intelligence with practical performance
const ModelClaudeOpus4_5 Model = "claude-opus-4-5"
const ModelClaudeOpus4_5 Model = "claude-opus-4-5"
Premium model combining maximum intelligence with practical performance
const ModelClaude3_7SonnetLatest Model = "claude-3-7-sonnet-latest"
const ModelClaude3_7SonnetLatest Model = "claude-3-7-sonnet-latest"
High-performance model with early extended thinking
const ModelClaude3_7Sonnet20250219 Model = "claude-3-7-sonnet-20250219"
const ModelClaude3_7Sonnet20250219 Model = "claude-3-7-sonnet-20250219"
High-performance model with early extended thinking
const ModelClaude3_5HaikuLatest Model = "claude-3-5-haiku-latest"
const ModelClaude3_5HaikuLatest Model = "claude-3-5-haiku-latest"
Fastest and most compact model for near-instant responsiveness
const ModelClaude3_5Haiku20241022 Model = "claude-3-5-haiku-20241022"
const ModelClaude3_5Haiku20241022 Model = "claude-3-5-haiku-20241022"
Our fastest model
const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"
const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"
Hybrid model, capable of near-instant responses and extended thinking
const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"
const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"
Hybrid model, capable of near-instant responses and extended thinking
const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"
const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"
High-performance model with extended thinking
const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"
const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"
High-performance model with extended thinking
const ModelClaude4Sonnet20250514 Model = "claude-4-sonnet-20250514"
const ModelClaude4Sonnet20250514 Model = "claude-4-sonnet-20250514"
High-performance model with extended thinking
const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"
const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"
Our best model for real-world agents and coding
const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"
const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"
Our best model for real-world agents and coding
const ModelClaudeOpus4_0 Model = "claude-opus-4-0"
const ModelClaudeOpus4_0 Model = "claude-opus-4-0"
Our most capable model
const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"
const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"
Our most capable model
const ModelClaude4Opus20250514 Model = "claude-4-opus-20250514"
const ModelClaude4Opus20250514 Model = "claude-4-opus-20250514"
Our most capable model
const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"
const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"
Our most capable model
const ModelClaude3OpusLatest Model = "claude-3-opus-latest"
const ModelClaude3OpusLatest Model = "claude-3-opus-latest"
Excels at writing and complex tasks
const ModelClaude_3_Opus_20240229 Model = "claude-3-opus-20240229"
const ModelClaude_3_Opus_20240229 Model = "claude-3-opus-20240229"
Excels at writing and complex tasks
const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"
const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"
Our previous most fast and cost-effective
string
Role Assistant
Role Assistant
Conversational role of the generated message.
This will always be "assistant".
Accepts one of the following:
const AssistantAssistant Assistant = "assistant"
StopReason BetaStopReason
StopReason BetaStopReason
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
Accepts one of the following:
StopSequence string
StopSequence 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 Message
Type Message
Object type.
For Messages, this is always "message".
Accepts one of the following:
const MessageMessage Message = "message"
Usage BetaUsage
Usage BetaUsage
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
CacheCreation BetaCacheCreation
CacheCreation BetaCacheCreation
Breakdown of cached tokens by TTL
Ephemeral1hInputTokens int64
Ephemeral1hInputTokens int64
The number of input tokens used to create the 1 hour cache entry.
minimum0
Ephemeral5mInputTokens int64
Ephemeral5mInputTokens int64
The number of input tokens used to create the 5 minute cache entry.
minimum0
CacheCreationInputTokens int64
CacheCreationInputTokens int64
The number of input tokens used to create the cache entry.
minimum0
CacheReadInputTokens int64
CacheReadInputTokens int64
The number of input tokens read from the cache.
minimum0
InputTokens int64
InputTokens int64
The number of input tokens which were used.
minimum0
OutputTokens int64
OutputTokens int64
The number of output tokens which were used.
minimum0
ServerToolUse BetaServerToolUsage
ServerToolUse BetaServerToolUsage
The number of server tool requests.
WebFetchRequests int64
WebFetchRequests int64
The number of web fetch tool requests.
minimum0
WebSearchRequests int64
WebSearchRequests int64
The number of web search tool requests.
minimum0
ServiceTier BetaUsageServiceTier
ServiceTier BetaUsageServiceTier
If the request used the priority, standard, or batch tier.
Accepts one of the following:
const BetaUsageServiceTierStandard BetaUsageServiceTier = "standard"
const BetaUsageServiceTierPriority BetaUsageServiceTier = "priority"
const BetaUsageServiceTierBatch BetaUsageServiceTier = "batch"
Type Succeeded
Type Succeeded
Accepts one of the following:
const SucceededSucceeded Succeeded = "succeeded"
type BetaMessageBatchErroredResult struct{…}
type BetaMessageBatchErroredResult struct{…}
Error BetaErrorResponse
Error BetaErrorResponse
Error BetaErrorUnion
Error BetaErrorUnion
Accepts one of the following:
type BetaInvalidRequestError struct{…}
type BetaInvalidRequestError struct{…}
Message string
Type InvalidRequestError
Type InvalidRequestError
Accepts one of the following:
const InvalidRequestErrorInvalidRequestError InvalidRequestError = "invalid_request_error"
type BetaAuthenticationError struct{…}
type BetaAuthenticationError struct{…}
Message string
Type AuthenticationError
Type AuthenticationError
Accepts one of the following:
const AuthenticationErrorAuthenticationError AuthenticationError = "authentication_error"
type BetaBillingError struct{…}
type BetaBillingError struct{…}
Message string
Type BillingError
Type BillingError
Accepts one of the following:
const BillingErrorBillingError BillingError = "billing_error"
type BetaPermissionError struct{…}
type BetaPermissionError struct{…}
Message string
Type PermissionError
Type PermissionError
Accepts one of the following:
const PermissionErrorPermissionError PermissionError = "permission_error"
type BetaNotFoundError struct{…}
type BetaNotFoundError struct{…}
Message string
Type NotFoundError
Type NotFoundError
Accepts one of the following:
const NotFoundErrorNotFoundError NotFoundError = "not_found_error"
type BetaRateLimitError struct{…}
type BetaRateLimitError struct{…}
Message string
Type RateLimitError
Type RateLimitError
Accepts one of the following:
const RateLimitErrorRateLimitError RateLimitError = "rate_limit_error"
type BetaGatewayTimeoutError struct{…}
type BetaGatewayTimeoutError struct{…}
Message string
Type TimeoutError
Type TimeoutError
Accepts one of the following:
const TimeoutErrorTimeoutError TimeoutError = "timeout_error"
type BetaAPIError struct{…}
type BetaAPIError struct{…}
Message string
Type APIError
Type APIError
Accepts one of the following:
const APIErrorAPIError APIError = "api_error"
type BetaOverloadedError struct{…}
type BetaOverloadedError struct{…}
Message string
Type OverloadedError
Type OverloadedError
Accepts one of the following:
const OverloadedErrorOverloadedError OverloadedError = "overloaded_error"
RequestID string
Type Error
Type Error
Accepts one of the following:
const ErrorError Error = "error"
Type Errored
Type Errored
Accepts one of the following:
const ErroredErrored Errored = "errored"
type BetaMessageBatchCanceledResult struct{…}
type BetaMessageBatchCanceledResult struct{…}
Type Canceled
Type Canceled
Accepts one of the following:
const CanceledCanceled Canceled = "canceled"
type BetaMessageBatchExpiredResult struct{…}
type BetaMessageBatchExpiredResult struct{…}
Type Expired
Type Expired
Accepts one of the following:
const ExpiredExpired Expired = "expired"
type BetaMessageBatchRequestCounts struct{…}
type BetaMessageBatchRequestCounts struct{…}
Canceled int64
Canceled int64
Number of requests in the Message Batch that have been canceled.
This is zero until processing of the entire Message Batch has ended.
Errored int64
Errored int64
Number of requests in the Message Batch that encountered an error.
This is zero until processing of the entire Message Batch has ended.
Expired int64
Expired int64
Number of requests in the Message Batch that have expired.
This is zero until processing of the entire Message Batch has ended.
Processing int64
Processing int64
Number of requests in the Message Batch that are processing.
Succeeded int64
Succeeded int64
Number of requests in the Message Batch that have completed successfully.
This is zero until processing of the entire Message Batch has ended.
type BetaMessageBatchResultUnion interface{…}
type BetaMessageBatchResultUnion interface{…}
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:
type BetaMessageBatchSucceededResult struct{…}
type BetaMessageBatchSucceededResult struct{…}
Message BetaMessage
Message BetaMessage
ID string
ID string
Unique object identifier.
The format and length of IDs may change over time.
Container BetaContainer
Container BetaContainer
Information about the container used in the request (for the code execution tool)
ID string
ID string
Identifier for the container used in this request
ExpiresAt Time
ExpiresAt Time
The time at which the container will expire.
formatdate-time
Skills []BetaSkill
Skills []BetaSkill
Skills loaded in the container
SkillID string
SkillID string
Skill ID
maxLength64
minLength1
Type BetaSkillType
Type BetaSkillType
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Accepts one of the following:
const BetaSkillTypeAnthropic BetaSkillType = "anthropic"
const BetaSkillTypeCustom BetaSkillType = "custom"
Version string
Version string
Skill version or 'latest' for most recent version
maxLength64
minLength1
Content []BetaContentBlockUnion
Content []BetaContentBlockUnion
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:
type BetaTextBlock struct{…}
type BetaTextBlock struct{…}
Citations []BetaTextCitationUnion
Citations []BetaTextCitationUnion
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
Accepts one of the following:
type BetaCitationCharLocation struct{…}
type BetaCitationCharLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
FileID string
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
type BetaThinkingBlock struct{…}
type BetaThinkingBlock struct{…}
Signature string
Thinking string
Type Thinking
Type Thinking
Accepts one of the following:
const ThinkingThinking Thinking = "thinking"
type BetaRedactedThinkingBlock struct{…}
type BetaRedactedThinkingBlock struct{…}
Data string
Type RedactedThinking
Type RedactedThinking
Accepts one of the following:
const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"
type BetaToolUseBlock struct{…}
type BetaToolUseBlock struct{…}
ID string
Input map[string, any]
Name string
Type ToolUse
Type ToolUse
Accepts one of the following:
const ToolUseToolUse ToolUse = "tool_use"
Caller BetaToolUseBlockCallerUnionoptional
Caller BetaToolUseBlockCallerUnionoptional
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
Type Direct
Accepts one of the following:
const DirectDirect Direct = "direct"
type BetaServerToolCaller struct{…}
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
type BetaServerToolUseBlock struct{…}
type BetaServerToolUseBlock struct{…}
ID string
Caller BetaServerToolUseBlockCallerUnion
Caller BetaServerToolUseBlockCallerUnion
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
Type Direct
Accepts one of the following:
const DirectDirect Direct = "direct"
type BetaServerToolCaller struct{…}
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
Input map[string, any]
Name BetaServerToolUseBlockName
Name BetaServerToolUseBlockName
Accepts one of the following:
const BetaServerToolUseBlockNameWebSearch BetaServerToolUseBlockName = "web_search"
const BetaServerToolUseBlockNameWebFetch BetaServerToolUseBlockName = "web_fetch"
const BetaServerToolUseBlockNameCodeExecution BetaServerToolUseBlockName = "code_execution"
const BetaServerToolUseBlockNameBashCodeExecution BetaServerToolUseBlockName = "bash_code_execution"
const BetaServerToolUseBlockNameTextEditorCodeExecution BetaServerToolUseBlockName = "text_editor_code_execution"
const BetaServerToolUseBlockNameToolSearchToolRegex BetaServerToolUseBlockName = "tool_search_tool_regex"
const BetaServerToolUseBlockNameToolSearchToolBm25 BetaServerToolUseBlockName = "tool_search_tool_bm25"
Type ServerToolUse
Type ServerToolUse
Accepts one of the following:
const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"
type BetaWebSearchToolResultBlock struct{…}
type BetaWebSearchToolResultBlock struct{…}
Accepts one of the following:
type BetaWebSearchToolResultError struct{…}
type BetaWebSearchToolResultError struct{…}
ErrorCode BetaWebSearchToolResultErrorCode
ErrorCode BetaWebSearchToolResultErrorCode
Accepts one of the following:
const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"
const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"
const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"
const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"
Type WebSearchToolResultError
Type WebSearchToolResultError
Accepts one of the following:
const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"
EncryptedContent string
PageAge string
Title string
Type WebSearchResult
Type WebSearchResult
Accepts one of the following:
const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"
URL string
ToolUseID string
Type WebSearchToolResult
Type WebSearchToolResult
Accepts one of the following:
const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"
type BetaWebFetchToolResultBlock struct{…}
type BetaWebFetchToolResultBlock struct{…}
Content BetaWebFetchToolResultBlockContentUnion
Content BetaWebFetchToolResultBlockContentUnion
Accepts one of the following:
type BetaWebFetchToolResultErrorBlock struct{…}
type BetaWebFetchToolResultErrorBlock struct{…}
ErrorCode BetaWebFetchToolResultErrorCode
ErrorCode BetaWebFetchToolResultErrorCode
Accepts one of the following:
const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"
const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"
const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"
const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"
const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"
const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"
Type WebFetchToolResultError
Type WebFetchToolResultError
Accepts one of the following:
const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"
type BetaWebFetchBlock struct{…}
type BetaWebFetchBlock struct{…}
Content BetaDocumentBlock
Content BetaDocumentBlock
Citations BetaCitationConfig
Citations BetaCitationConfig
Citation configuration for the document
Enabled bool
Source BetaDocumentBlockSourceUnion
Source BetaDocumentBlockSourceUnion
Accepts one of the following:
type BetaBase64PDFSource struct{…}
type BetaBase64PDFSource struct{…}
Data string
MediaType ApplicationPDF
MediaType ApplicationPDF
Accepts one of the following:
const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaPlainTextSource struct{…}
type BetaPlainTextSource struct{…}
Data string
MediaType TextPlain
MediaType TextPlain
Accepts one of the following:
const TextPlainTextPlain TextPlain = "text/plain"
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Title string
Title string
The title of the document
Type Document
Type Document
Accepts one of the following:
const DocumentDocument Document = "document"
RetrievedAt string
RetrievedAt string
ISO 8601 timestamp when the content was retrieved
Type WebFetchResult
Type WebFetchResult
Accepts one of the following:
const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"
URL string
URL string
Fetched content URL
ToolUseID string
Type WebFetchToolResult
Type WebFetchToolResult
Accepts one of the following:
const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"
type BetaCodeExecutionToolResultBlock struct{…}
type BetaCodeExecutionToolResultBlock struct{…}
Accepts one of the following:
type BetaCodeExecutionToolResultError struct{…}
type BetaCodeExecutionToolResultError struct{…}
ErrorCode BetaCodeExecutionToolResultErrorCode
ErrorCode BetaCodeExecutionToolResultErrorCode
Accepts one of the following:
const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"
const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"
const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"
const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"
Type CodeExecutionToolResultError
Type CodeExecutionToolResultError
Accepts one of the following:
const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"
type BetaCodeExecutionResultBlock struct{…}
type BetaCodeExecutionResultBlock struct{…}
Content []BetaCodeExecutionOutputBlock
Content []BetaCodeExecutionOutputBlock
FileID string
Type CodeExecutionOutput
Type CodeExecutionOutput
Accepts one of the following:
const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type CodeExecutionResult
Type CodeExecutionResult
Accepts one of the following:
const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"
ToolUseID string
Type CodeExecutionToolResult
Type CodeExecutionToolResult
Accepts one of the following:
const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"
type BetaBashCodeExecutionToolResultBlock struct{…}
type BetaBashCodeExecutionToolResultBlock struct{…}
Content BetaBashCodeExecutionToolResultBlockContentUnion
Content BetaBashCodeExecutionToolResultBlockContentUnion
Accepts one of the following:
type BetaBashCodeExecutionToolResultError struct{…}
type BetaBashCodeExecutionToolResultError struct{…}
ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode
ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode
Accepts one of the following:
const BetaBashCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"
const BetaBashCodeExecutionToolResultErrorErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorErrorCode = "unavailable"
const BetaBashCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorErrorCode = "too_many_requests"
const BetaBashCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"
const BetaBashCodeExecutionToolResultErrorErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorErrorCode = "output_file_too_large"
Type BashCodeExecutionToolResultError
Type BashCodeExecutionToolResultError
Accepts one of the following:
const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"
type BetaBashCodeExecutionResultBlock struct{…}
type BetaBashCodeExecutionResultBlock struct{…}
Content []BetaBashCodeExecutionOutputBlock
Content []BetaBashCodeExecutionOutputBlock
FileID string
Type BashCodeExecutionOutput
Type BashCodeExecutionOutput
Accepts one of the following:
const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type BashCodeExecutionResult
Type BashCodeExecutionResult
Accepts one of the following:
const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"
ToolUseID string
Type BashCodeExecutionToolResult
Type BashCodeExecutionToolResult
Accepts one of the following:
const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"
type BetaTextEditorCodeExecutionToolResultBlock struct{…}
type BetaTextEditorCodeExecutionToolResultBlock struct{…}
Content BetaTextEditorCodeExecutionToolResultBlockContentUnion
Content BetaTextEditorCodeExecutionToolResultBlockContentUnion
Accepts one of the following:
type BetaTextEditorCodeExecutionToolResultError struct{…}
type BetaTextEditorCodeExecutionToolResultError struct{…}
ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode
ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode
Accepts one of the following:
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorErrorCode = "unavailable"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorErrorCode = "too_many_requests"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorErrorCode = "file_not_found"
ErrorMessage string
Type TextEditorCodeExecutionToolResultError
Type TextEditorCodeExecutionToolResultError
Accepts one of the following:
const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"
type BetaTextEditorCodeExecutionViewResultBlock struct{…}
type BetaTextEditorCodeExecutionViewResultBlock struct{…}
Content string
FileType BetaTextEditorCodeExecutionViewResultBlockFileType
FileType BetaTextEditorCodeExecutionViewResultBlockFileType
Accepts one of the following:
const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"
const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"
const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"
NumLines int64
StartLine int64
TotalLines int64
Type TextEditorCodeExecutionViewResult
Type TextEditorCodeExecutionViewResult
Accepts one of the following:
const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"
type BetaTextEditorCodeExecutionCreateResultBlock struct{…}
type BetaTextEditorCodeExecutionCreateResultBlock struct{…}
IsFileUpdate bool
Type TextEditorCodeExecutionCreateResult
Type TextEditorCodeExecutionCreateResult
Accepts one of the following:
const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"
type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}
type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}
Lines []string
NewLines int64
NewStart int64
OldLines int64
OldStart int64
Type TextEditorCodeExecutionStrReplaceResult
Type TextEditorCodeExecutionStrReplaceResult
Accepts one of the following:
const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"
ToolUseID string
Type TextEditorCodeExecutionToolResult
Type TextEditorCodeExecutionToolResult
Accepts one of the following:
const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"
type BetaToolSearchToolResultBlock struct{…}
type BetaToolSearchToolResultBlock struct{…}
Content BetaToolSearchToolResultBlockContentUnion
Content BetaToolSearchToolResultBlockContentUnion
Accepts one of the following:
type BetaToolSearchToolResultError struct{…}
type BetaToolSearchToolResultError struct{…}
ErrorCode BetaToolSearchToolResultErrorErrorCode
ErrorCode BetaToolSearchToolResultErrorErrorCode
Accepts one of the following:
const BetaToolSearchToolResultErrorErrorCodeInvalidToolInput BetaToolSearchToolResultErrorErrorCode = "invalid_tool_input"
const BetaToolSearchToolResultErrorErrorCodeUnavailable BetaToolSearchToolResultErrorErrorCode = "unavailable"
const BetaToolSearchToolResultErrorErrorCodeTooManyRequests BetaToolSearchToolResultErrorErrorCode = "too_many_requests"
const BetaToolSearchToolResultErrorErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorErrorCode = "execution_time_exceeded"
ErrorMessage string
Type ToolSearchToolResultError
Type ToolSearchToolResultError
Accepts one of the following:
const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"
type BetaToolSearchToolSearchResultBlock struct{…}
type BetaToolSearchToolSearchResultBlock struct{…}
ToolReferences []BetaToolReferenceBlock
ToolReferences []BetaToolReferenceBlock
ToolName string
Type ToolReference
Type ToolReference
Accepts one of the following:
const ToolReferenceToolReference ToolReference = "tool_reference"
Type ToolSearchToolSearchResult
Type ToolSearchToolSearchResult
Accepts one of the following:
const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"
ToolUseID string
Type ToolSearchToolResult
Type ToolSearchToolResult
Accepts one of the following:
const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"
type BetaMCPToolUseBlock struct{…}
type BetaMCPToolUseBlock struct{…}
ID string
Input map[string, any]
Name string
Name string
The name of the MCP tool
ServerName string
ServerName string
The name of the MCP server
Type MCPToolUse
Type MCPToolUse
Accepts one of the following:
const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"
type BetaMCPToolResultBlock struct{…}
type BetaMCPToolResultBlock struct{…}
Content BetaMCPToolResultBlockContentUnion
Content BetaMCPToolResultBlockContentUnion
Accepts one of the following:
string
Citations []BetaTextCitationUnion
Citations []BetaTextCitationUnion
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
Accepts one of the following:
type BetaCitationCharLocation struct{…}
type BetaCitationCharLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
FileID string
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
IsError bool
ToolUseID string
Type MCPToolResult
Type MCPToolResult
Accepts one of the following:
const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"
type BetaContainerUploadBlock struct{…}
type BetaContainerUploadBlock struct{…}
Response model for a file uploaded to the container.
FileID string
Type ContainerUpload
Type ContainerUpload
Accepts one of the following:
const ContainerUploadContainerUpload ContainerUpload = "container_upload"
ContextManagement BetaContextManagementResponse
ContextManagement BetaContextManagementResponse
Context management response.
Information about context management strategies applied during the request.
AppliedEdits []BetaContextManagementResponseAppliedEditUnion
AppliedEdits []BetaContextManagementResponseAppliedEditUnion
List of context management edits that were applied.
Accepts one of the following:
type BetaClearToolUses20250919EditResponse struct{…}
type BetaClearToolUses20250919EditResponse struct{…}
ClearedInputTokens int64
ClearedInputTokens int64
Number of input tokens cleared by this edit.
minimum0
ClearedToolUses int64
ClearedToolUses int64
Number of tool uses that were cleared.
minimum0
Type ClearToolUses20250919
Type ClearToolUses20250919
The type of context management edit applied.
Accepts one of the following:
const ClearToolUses20250919ClearToolUses20250919 ClearToolUses20250919 = "clear_tool_uses_20250919"
type BetaClearThinking20251015EditResponse struct{…}
type BetaClearThinking20251015EditResponse struct{…}
ClearedInputTokens int64
ClearedInputTokens int64
Number of input tokens cleared by this edit.
minimum0
ClearedThinkingTurns int64
ClearedThinkingTurns int64
Number of thinking turns that were cleared.
minimum0
Type ClearThinking20251015
Type ClearThinking20251015
The type of context management edit applied.
Accepts one of the following:
const ClearThinking20251015ClearThinking20251015 ClearThinking20251015 = "clear_thinking_20251015"
Model Model
Model Model
The model that will complete your prompt.
See models for additional details and options.
Accepts one of the following:
type Model string
type Model string
The model that will complete your prompt.
See models for additional details and options.
Accepts one of the following:
const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"
const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"
Premium model combining maximum intelligence with practical performance
const ModelClaudeOpus4_5 Model = "claude-opus-4-5"
const ModelClaudeOpus4_5 Model = "claude-opus-4-5"
Premium model combining maximum intelligence with practical performance
const ModelClaude3_7SonnetLatest Model = "claude-3-7-sonnet-latest"
const ModelClaude3_7SonnetLatest Model = "claude-3-7-sonnet-latest"
High-performance model with early extended thinking
const ModelClaude3_7Sonnet20250219 Model = "claude-3-7-sonnet-20250219"
const ModelClaude3_7Sonnet20250219 Model = "claude-3-7-sonnet-20250219"
High-performance model with early extended thinking
const ModelClaude3_5HaikuLatest Model = "claude-3-5-haiku-latest"
const ModelClaude3_5HaikuLatest Model = "claude-3-5-haiku-latest"
Fastest and most compact model for near-instant responsiveness
const ModelClaude3_5Haiku20241022 Model = "claude-3-5-haiku-20241022"
const ModelClaude3_5Haiku20241022 Model = "claude-3-5-haiku-20241022"
Our fastest model
const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"
const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"
Hybrid model, capable of near-instant responses and extended thinking
const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"
const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"
Hybrid model, capable of near-instant responses and extended thinking
const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"
const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"
High-performance model with extended thinking
const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"
const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"
High-performance model with extended thinking
const ModelClaude4Sonnet20250514 Model = "claude-4-sonnet-20250514"
const ModelClaude4Sonnet20250514 Model = "claude-4-sonnet-20250514"
High-performance model with extended thinking
const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"
const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"
Our best model for real-world agents and coding
const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"
const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"
Our best model for real-world agents and coding
const ModelClaudeOpus4_0 Model = "claude-opus-4-0"
const ModelClaudeOpus4_0 Model = "claude-opus-4-0"
Our most capable model
const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"
const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"
Our most capable model
const ModelClaude4Opus20250514 Model = "claude-4-opus-20250514"
const ModelClaude4Opus20250514 Model = "claude-4-opus-20250514"
Our most capable model
const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"
const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"
Our most capable model
const ModelClaude3OpusLatest Model = "claude-3-opus-latest"
const ModelClaude3OpusLatest Model = "claude-3-opus-latest"
Excels at writing and complex tasks
const ModelClaude_3_Opus_20240229 Model = "claude-3-opus-20240229"
const ModelClaude_3_Opus_20240229 Model = "claude-3-opus-20240229"
Excels at writing and complex tasks
const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"
const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"
Our previous most fast and cost-effective
string
Role Assistant
Role Assistant
Conversational role of the generated message.
This will always be "assistant".
Accepts one of the following:
const AssistantAssistant Assistant = "assistant"
StopReason BetaStopReason
StopReason BetaStopReason
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
Accepts one of the following:
StopSequence string
StopSequence 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 Message
Type Message
Object type.
For Messages, this is always "message".
Accepts one of the following:
const MessageMessage Message = "message"
Usage BetaUsage
Usage BetaUsage
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
CacheCreation BetaCacheCreation
CacheCreation BetaCacheCreation
Breakdown of cached tokens by TTL
Ephemeral1hInputTokens int64
Ephemeral1hInputTokens int64
The number of input tokens used to create the 1 hour cache entry.
minimum0
Ephemeral5mInputTokens int64
Ephemeral5mInputTokens int64
The number of input tokens used to create the 5 minute cache entry.
minimum0
CacheCreationInputTokens int64
CacheCreationInputTokens int64
The number of input tokens used to create the cache entry.
minimum0
CacheReadInputTokens int64
CacheReadInputTokens int64
The number of input tokens read from the cache.
minimum0
InputTokens int64
InputTokens int64
The number of input tokens which were used.
minimum0
OutputTokens int64
OutputTokens int64
The number of output tokens which were used.
minimum0
ServerToolUse BetaServerToolUsage
ServerToolUse BetaServerToolUsage
The number of server tool requests.
WebFetchRequests int64
WebFetchRequests int64
The number of web fetch tool requests.
minimum0
WebSearchRequests int64
WebSearchRequests int64
The number of web search tool requests.
minimum0
ServiceTier BetaUsageServiceTier
ServiceTier BetaUsageServiceTier
If the request used the priority, standard, or batch tier.
Accepts one of the following:
const BetaUsageServiceTierStandard BetaUsageServiceTier = "standard"
const BetaUsageServiceTierPriority BetaUsageServiceTier = "priority"
const BetaUsageServiceTierBatch BetaUsageServiceTier = "batch"
Type Succeeded
Type Succeeded
Accepts one of the following:
const SucceededSucceeded Succeeded = "succeeded"
type BetaMessageBatchErroredResult struct{…}
type BetaMessageBatchErroredResult struct{…}
Error BetaErrorResponse
Error BetaErrorResponse
Error BetaErrorUnion
Error BetaErrorUnion
Accepts one of the following:
type BetaInvalidRequestError struct{…}
type BetaInvalidRequestError struct{…}
Message string
Type InvalidRequestError
Type InvalidRequestError
Accepts one of the following:
const InvalidRequestErrorInvalidRequestError InvalidRequestError = "invalid_request_error"
type BetaAuthenticationError struct{…}
type BetaAuthenticationError struct{…}
Message string
Type AuthenticationError
Type AuthenticationError
Accepts one of the following:
const AuthenticationErrorAuthenticationError AuthenticationError = "authentication_error"
type BetaBillingError struct{…}
type BetaBillingError struct{…}
Message string
Type BillingError
Type BillingError
Accepts one of the following:
const BillingErrorBillingError BillingError = "billing_error"
type BetaPermissionError struct{…}
type BetaPermissionError struct{…}
Message string
Type PermissionError
Type PermissionError
Accepts one of the following:
const PermissionErrorPermissionError PermissionError = "permission_error"
type BetaNotFoundError struct{…}
type BetaNotFoundError struct{…}
Message string
Type NotFoundError
Type NotFoundError
Accepts one of the following:
const NotFoundErrorNotFoundError NotFoundError = "not_found_error"
type BetaRateLimitError struct{…}
type BetaRateLimitError struct{…}
Message string
Type RateLimitError
Type RateLimitError
Accepts one of the following:
const RateLimitErrorRateLimitError RateLimitError = "rate_limit_error"
type BetaGatewayTimeoutError struct{…}
type BetaGatewayTimeoutError struct{…}
Message string
Type TimeoutError
Type TimeoutError
Accepts one of the following:
const TimeoutErrorTimeoutError TimeoutError = "timeout_error"
type BetaAPIError struct{…}
type BetaAPIError struct{…}
Message string
Type APIError
Type APIError
Accepts one of the following:
const APIErrorAPIError APIError = "api_error"
type BetaOverloadedError struct{…}
type BetaOverloadedError struct{…}
Message string
Type OverloadedError
Type OverloadedError
Accepts one of the following:
const OverloadedErrorOverloadedError OverloadedError = "overloaded_error"
RequestID string
Type Error
Type Error
Accepts one of the following:
const ErrorError Error = "error"
Type Errored
Type Errored
Accepts one of the following:
const ErroredErrored Errored = "errored"
type BetaMessageBatchCanceledResult struct{…}
type BetaMessageBatchCanceledResult struct{…}
Type Canceled
Type Canceled
Accepts one of the following:
const CanceledCanceled Canceled = "canceled"
type BetaMessageBatchExpiredResult struct{…}
type BetaMessageBatchExpiredResult struct{…}
Type Expired
Type Expired
Accepts one of the following:
const ExpiredExpired Expired = "expired"
type BetaMessageBatchSucceededResult struct{…}
type BetaMessageBatchSucceededResult struct{…}
Message BetaMessage
Message BetaMessage
ID string
ID string
Unique object identifier.
The format and length of IDs may change over time.
Container BetaContainer
Container BetaContainer
Information about the container used in the request (for the code execution tool)
ID string
ID string
Identifier for the container used in this request
ExpiresAt Time
ExpiresAt Time
The time at which the container will expire.
formatdate-time
Skills []BetaSkill
Skills []BetaSkill
Skills loaded in the container
SkillID string
SkillID string
Skill ID
maxLength64
minLength1
Type BetaSkillType
Type BetaSkillType
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Accepts one of the following:
const BetaSkillTypeAnthropic BetaSkillType = "anthropic"
const BetaSkillTypeCustom BetaSkillType = "custom"
Version string
Version string
Skill version or 'latest' for most recent version
maxLength64
minLength1
Content []BetaContentBlockUnion
Content []BetaContentBlockUnion
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:
type BetaTextBlock struct{…}
type BetaTextBlock struct{…}
Citations []BetaTextCitationUnion
Citations []BetaTextCitationUnion
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
Accepts one of the following:
type BetaCitationCharLocation struct{…}
type BetaCitationCharLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
FileID string
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
type BetaThinkingBlock struct{…}
type BetaThinkingBlock struct{…}
Signature string
Thinking string
Type Thinking
Type Thinking
Accepts one of the following:
const ThinkingThinking Thinking = "thinking"
type BetaRedactedThinkingBlock struct{…}
type BetaRedactedThinkingBlock struct{…}
Data string
Type RedactedThinking
Type RedactedThinking
Accepts one of the following:
const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"
type BetaToolUseBlock struct{…}
type BetaToolUseBlock struct{…}
ID string
Input map[string, any]
Name string
Type ToolUse
Type ToolUse
Accepts one of the following:
const ToolUseToolUse ToolUse = "tool_use"
Caller BetaToolUseBlockCallerUnionoptional
Caller BetaToolUseBlockCallerUnionoptional
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
Type Direct
Accepts one of the following:
const DirectDirect Direct = "direct"
type BetaServerToolCaller struct{…}
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
type BetaServerToolUseBlock struct{…}
type BetaServerToolUseBlock struct{…}
ID string
Caller BetaServerToolUseBlockCallerUnion
Caller BetaServerToolUseBlockCallerUnion
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
Type Direct
Accepts one of the following:
const DirectDirect Direct = "direct"
type BetaServerToolCaller struct{…}
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
Type CodeExecution20250825
Accepts one of the following:
const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"
Input map[string, any]
Name BetaServerToolUseBlockName
Name BetaServerToolUseBlockName
Accepts one of the following:
const BetaServerToolUseBlockNameWebSearch BetaServerToolUseBlockName = "web_search"
const BetaServerToolUseBlockNameWebFetch BetaServerToolUseBlockName = "web_fetch"
const BetaServerToolUseBlockNameCodeExecution BetaServerToolUseBlockName = "code_execution"
const BetaServerToolUseBlockNameBashCodeExecution BetaServerToolUseBlockName = "bash_code_execution"
const BetaServerToolUseBlockNameTextEditorCodeExecution BetaServerToolUseBlockName = "text_editor_code_execution"
const BetaServerToolUseBlockNameToolSearchToolRegex BetaServerToolUseBlockName = "tool_search_tool_regex"
const BetaServerToolUseBlockNameToolSearchToolBm25 BetaServerToolUseBlockName = "tool_search_tool_bm25"
Type ServerToolUse
Type ServerToolUse
Accepts one of the following:
const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"
type BetaWebSearchToolResultBlock struct{…}
type BetaWebSearchToolResultBlock struct{…}
Accepts one of the following:
type BetaWebSearchToolResultError struct{…}
type BetaWebSearchToolResultError struct{…}
ErrorCode BetaWebSearchToolResultErrorCode
ErrorCode BetaWebSearchToolResultErrorCode
Accepts one of the following:
const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"
const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"
const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"
const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"
Type WebSearchToolResultError
Type WebSearchToolResultError
Accepts one of the following:
const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"
EncryptedContent string
PageAge string
Title string
Type WebSearchResult
Type WebSearchResult
Accepts one of the following:
const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"
URL string
ToolUseID string
Type WebSearchToolResult
Type WebSearchToolResult
Accepts one of the following:
const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"
type BetaWebFetchToolResultBlock struct{…}
type BetaWebFetchToolResultBlock struct{…}
Content BetaWebFetchToolResultBlockContentUnion
Content BetaWebFetchToolResultBlockContentUnion
Accepts one of the following:
type BetaWebFetchToolResultErrorBlock struct{…}
type BetaWebFetchToolResultErrorBlock struct{…}
ErrorCode BetaWebFetchToolResultErrorCode
ErrorCode BetaWebFetchToolResultErrorCode
Accepts one of the following:
const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"
const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"
const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"
const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"
const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"
const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"
Type WebFetchToolResultError
Type WebFetchToolResultError
Accepts one of the following:
const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"
type BetaWebFetchBlock struct{…}
type BetaWebFetchBlock struct{…}
Content BetaDocumentBlock
Content BetaDocumentBlock
Citations BetaCitationConfig
Citations BetaCitationConfig
Citation configuration for the document
Enabled bool
Source BetaDocumentBlockSourceUnion
Source BetaDocumentBlockSourceUnion
Accepts one of the following:
type BetaBase64PDFSource struct{…}
type BetaBase64PDFSource struct{…}
Data string
MediaType ApplicationPDF
MediaType ApplicationPDF
Accepts one of the following:
const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"
Type Base64
Type Base64
Accepts one of the following:
const Base64Base64 Base64 = "base64"
type BetaPlainTextSource struct{…}
type BetaPlainTextSource struct{…}
Data string
MediaType TextPlain
MediaType TextPlain
Accepts one of the following:
const TextPlainTextPlain TextPlain = "text/plain"
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
Title string
Title string
The title of the document
Type Document
Type Document
Accepts one of the following:
const DocumentDocument Document = "document"
RetrievedAt string
RetrievedAt string
ISO 8601 timestamp when the content was retrieved
Type WebFetchResult
Type WebFetchResult
Accepts one of the following:
const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"
URL string
URL string
Fetched content URL
ToolUseID string
Type WebFetchToolResult
Type WebFetchToolResult
Accepts one of the following:
const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"
type BetaCodeExecutionToolResultBlock struct{…}
type BetaCodeExecutionToolResultBlock struct{…}
Accepts one of the following:
type BetaCodeExecutionToolResultError struct{…}
type BetaCodeExecutionToolResultError struct{…}
ErrorCode BetaCodeExecutionToolResultErrorCode
ErrorCode BetaCodeExecutionToolResultErrorCode
Accepts one of the following:
const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"
const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"
const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"
const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"
Type CodeExecutionToolResultError
Type CodeExecutionToolResultError
Accepts one of the following:
const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"
type BetaCodeExecutionResultBlock struct{…}
type BetaCodeExecutionResultBlock struct{…}
Content []BetaCodeExecutionOutputBlock
Content []BetaCodeExecutionOutputBlock
FileID string
Type CodeExecutionOutput
Type CodeExecutionOutput
Accepts one of the following:
const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type CodeExecutionResult
Type CodeExecutionResult
Accepts one of the following:
const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"
ToolUseID string
Type CodeExecutionToolResult
Type CodeExecutionToolResult
Accepts one of the following:
const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"
type BetaBashCodeExecutionToolResultBlock struct{…}
type BetaBashCodeExecutionToolResultBlock struct{…}
Content BetaBashCodeExecutionToolResultBlockContentUnion
Content BetaBashCodeExecutionToolResultBlockContentUnion
Accepts one of the following:
type BetaBashCodeExecutionToolResultError struct{…}
type BetaBashCodeExecutionToolResultError struct{…}
ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode
ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode
Accepts one of the following:
const BetaBashCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"
const BetaBashCodeExecutionToolResultErrorErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorErrorCode = "unavailable"
const BetaBashCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorErrorCode = "too_many_requests"
const BetaBashCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"
const BetaBashCodeExecutionToolResultErrorErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorErrorCode = "output_file_too_large"
Type BashCodeExecutionToolResultError
Type BashCodeExecutionToolResultError
Accepts one of the following:
const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"
type BetaBashCodeExecutionResultBlock struct{…}
type BetaBashCodeExecutionResultBlock struct{…}
Content []BetaBashCodeExecutionOutputBlock
Content []BetaBashCodeExecutionOutputBlock
FileID string
Type BashCodeExecutionOutput
Type BashCodeExecutionOutput
Accepts one of the following:
const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"
ReturnCode int64
Stderr string
Stdout string
Type BashCodeExecutionResult
Type BashCodeExecutionResult
Accepts one of the following:
const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"
ToolUseID string
Type BashCodeExecutionToolResult
Type BashCodeExecutionToolResult
Accepts one of the following:
const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"
type BetaTextEditorCodeExecutionToolResultBlock struct{…}
type BetaTextEditorCodeExecutionToolResultBlock struct{…}
Content BetaTextEditorCodeExecutionToolResultBlockContentUnion
Content BetaTextEditorCodeExecutionToolResultBlockContentUnion
Accepts one of the following:
type BetaTextEditorCodeExecutionToolResultError struct{…}
type BetaTextEditorCodeExecutionToolResultError struct{…}
ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode
ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode
Accepts one of the following:
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorErrorCode = "unavailable"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorErrorCode = "too_many_requests"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"
const BetaTextEditorCodeExecutionToolResultErrorErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorErrorCode = "file_not_found"
ErrorMessage string
Type TextEditorCodeExecutionToolResultError
Type TextEditorCodeExecutionToolResultError
Accepts one of the following:
const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"
type BetaTextEditorCodeExecutionViewResultBlock struct{…}
type BetaTextEditorCodeExecutionViewResultBlock struct{…}
Content string
FileType BetaTextEditorCodeExecutionViewResultBlockFileType
FileType BetaTextEditorCodeExecutionViewResultBlockFileType
Accepts one of the following:
const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"
const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"
const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"
NumLines int64
StartLine int64
TotalLines int64
Type TextEditorCodeExecutionViewResult
Type TextEditorCodeExecutionViewResult
Accepts one of the following:
const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"
type BetaTextEditorCodeExecutionCreateResultBlock struct{…}
type BetaTextEditorCodeExecutionCreateResultBlock struct{…}
IsFileUpdate bool
Type TextEditorCodeExecutionCreateResult
Type TextEditorCodeExecutionCreateResult
Accepts one of the following:
const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"
type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}
type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}
Lines []string
NewLines int64
NewStart int64
OldLines int64
OldStart int64
Type TextEditorCodeExecutionStrReplaceResult
Type TextEditorCodeExecutionStrReplaceResult
Accepts one of the following:
const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"
ToolUseID string
Type TextEditorCodeExecutionToolResult
Type TextEditorCodeExecutionToolResult
Accepts one of the following:
const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"
type BetaToolSearchToolResultBlock struct{…}
type BetaToolSearchToolResultBlock struct{…}
Content BetaToolSearchToolResultBlockContentUnion
Content BetaToolSearchToolResultBlockContentUnion
Accepts one of the following:
type BetaToolSearchToolResultError struct{…}
type BetaToolSearchToolResultError struct{…}
ErrorCode BetaToolSearchToolResultErrorErrorCode
ErrorCode BetaToolSearchToolResultErrorErrorCode
Accepts one of the following:
const BetaToolSearchToolResultErrorErrorCodeInvalidToolInput BetaToolSearchToolResultErrorErrorCode = "invalid_tool_input"
const BetaToolSearchToolResultErrorErrorCodeUnavailable BetaToolSearchToolResultErrorErrorCode = "unavailable"
const BetaToolSearchToolResultErrorErrorCodeTooManyRequests BetaToolSearchToolResultErrorErrorCode = "too_many_requests"
const BetaToolSearchToolResultErrorErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorErrorCode = "execution_time_exceeded"
ErrorMessage string
Type ToolSearchToolResultError
Type ToolSearchToolResultError
Accepts one of the following:
const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"
type BetaToolSearchToolSearchResultBlock struct{…}
type BetaToolSearchToolSearchResultBlock struct{…}
ToolReferences []BetaToolReferenceBlock
ToolReferences []BetaToolReferenceBlock
ToolName string
Type ToolReference
Type ToolReference
Accepts one of the following:
const ToolReferenceToolReference ToolReference = "tool_reference"
Type ToolSearchToolSearchResult
Type ToolSearchToolSearchResult
Accepts one of the following:
const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"
ToolUseID string
Type ToolSearchToolResult
Type ToolSearchToolResult
Accepts one of the following:
const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"
type BetaMCPToolUseBlock struct{…}
type BetaMCPToolUseBlock struct{…}
ID string
Input map[string, any]
Name string
Name string
The name of the MCP tool
ServerName string
ServerName string
The name of the MCP server
Type MCPToolUse
Type MCPToolUse
Accepts one of the following:
const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"
type BetaMCPToolResultBlock struct{…}
type BetaMCPToolResultBlock struct{…}
Content BetaMCPToolResultBlockContentUnion
Content BetaMCPToolResultBlockContentUnion
Accepts one of the following:
string
Citations []BetaTextCitationUnion
Citations []BetaTextCitationUnion
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
Accepts one of the following:
type BetaCitationCharLocation struct{…}
type BetaCitationCharLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
FileID string
StartCharIndex int64
Type CharLocation
Type CharLocation
Accepts one of the following:
const CharLocationCharLocation CharLocation = "char_location"
type BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
Type PageLocation
Accepts one of the following:
const PageLocationPageLocation PageLocation = "page_location"
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
Type ContentBlockLocation
Accepts one of the following:
const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
Type WebSearchResultLocation
Accepts one of the following:
const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type SearchResultLocation
Accepts one of the following:
const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"
Text string
Type Text
Type Text
Accepts one of the following:
const TextText Text = "text"
IsError bool
ToolUseID string
Type MCPToolResult
Type MCPToolResult
Accepts one of the following:
const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"
type BetaContainerUploadBlock struct{…}
type BetaContainerUploadBlock struct{…}
Response model for a file uploaded to the container.
FileID string
Type ContainerUpload
Type ContainerUpload
Accepts one of the following:
const ContainerUploadContainerUpload ContainerUpload = "container_upload"
ContextManagement BetaContextManagementResponse
ContextManagement BetaContextManagementResponse
Context management response.
Information about context management strategies applied during the request.
AppliedEdits []BetaContextManagementResponseAppliedEditUnion
AppliedEdits []BetaContextManagementResponseAppliedEditUnion
List of context management edits that were applied.
Accepts one of the following:
type BetaClearToolUses20250919EditResponse struct{…}
type BetaClearToolUses20250919EditResponse struct{…}
ClearedInputTokens int64
ClearedInputTokens int64
Number of input tokens cleared by this edit.
minimum0
ClearedToolUses int64
ClearedToolUses int64
Number of tool uses that were cleared.
minimum0
Type ClearToolUses20250919
Type ClearToolUses20250919
The type of context management edit applied.
Accepts one of the following:
const ClearToolUses20250919ClearToolUses20250919 ClearToolUses20250919 = "clear_tool_uses_20250919"
type BetaClearThinking20251015EditResponse struct{…}
type BetaClearThinking20251015EditResponse struct{…}
ClearedInputTokens int64
ClearedInputTokens int64
Number of input tokens cleared by this edit.
minimum0
ClearedThinkingTurns int64
ClearedThinkingTurns int64
Number of thinking turns that were cleared.
minimum0
Type ClearThinking20251015
Type ClearThinking20251015
The type of context management edit applied.
Accepts one of the following:
const ClearThinking20251015ClearThinking20251015 ClearThinking20251015 = "clear_thinking_20251015"
Model Model
Model Model
The model that will complete your prompt.
See models for additional details and options.
Accepts one of the following:
type Model string
type Model string
The model that will complete your prompt.
See models for additional details and options.
Accepts one of the following:
const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"
const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"
Premium model combining maximum intelligence with practical performance
const ModelClaudeOpus4_5 Model = "claude-opus-4-5"
const ModelClaudeOpus4_5 Model = "claude-opus-4-5"
Premium model combining maximum intelligence with practical performance
const ModelClaude3_7SonnetLatest Model = "claude-3-7-sonnet-latest"
const ModelClaude3_7SonnetLatest Model = "claude-3-7-sonnet-latest"
High-performance model with early extended thinking
const ModelClaude3_7Sonnet20250219 Model = "claude-3-7-sonnet-20250219"
const ModelClaude3_7Sonnet20250219 Model = "claude-3-7-sonnet-20250219"
High-performance model with early extended thinking
const ModelClaude3_5HaikuLatest Model = "claude-3-5-haiku-latest"
const ModelClaude3_5HaikuLatest Model = "claude-3-5-haiku-latest"
Fastest and most compact model for near-instant responsiveness
const ModelClaude3_5Haiku20241022 Model = "claude-3-5-haiku-20241022"
const ModelClaude3_5Haiku20241022 Model = "claude-3-5-haiku-20241022"
Our fastest model
const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"
const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"
Hybrid model, capable of near-instant responses and extended thinking
const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"
const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"
Hybrid model, capable of near-instant responses and extended thinking
const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"
const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"
High-performance model with extended thinking
const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"
const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"
High-performance model with extended thinking
const ModelClaude4Sonnet20250514 Model = "claude-4-sonnet-20250514"
const ModelClaude4Sonnet20250514 Model = "claude-4-sonnet-20250514"
High-performance model with extended thinking
const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"
const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"
Our best model for real-world agents and coding
const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"
const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"
Our best model for real-world agents and coding
const ModelClaudeOpus4_0 Model = "claude-opus-4-0"
const ModelClaudeOpus4_0 Model = "claude-opus-4-0"
Our most capable model
const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"
const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"
Our most capable model
const ModelClaude4Opus20250514 Model = "claude-4-opus-20250514"
const ModelClaude4Opus20250514 Model = "claude-4-opus-20250514"
Our most capable model
const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"
const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"
Our most capable model
const ModelClaude3OpusLatest Model = "claude-3-opus-latest"
const ModelClaude3OpusLatest Model = "claude-3-opus-latest"
Excels at writing and complex tasks
const ModelClaude_3_Opus_20240229 Model = "claude-3-opus-20240229"
const ModelClaude_3_Opus_20240229 Model = "claude-3-opus-20240229"
Excels at writing and complex tasks
const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"
const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"
Our previous most fast and cost-effective
string
Role Assistant
Role Assistant
Conversational role of the generated message.
This will always be "assistant".
Accepts one of the following:
const AssistantAssistant Assistant = "assistant"
StopReason BetaStopReason
StopReason BetaStopReason
The reason that we stopped.
This may be one the following values:
"end_turn": the model reached a natural stopping point"max_tokens": we exceeded the requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas generated"tool_use": the model invoked one or more tools"pause_turn": we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue."refusal": when streaming classifiers intervene to handle potential policy violations
In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.
Accepts one of the following:
StopSequence string
StopSequence 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 Message
Type Message
Object type.
For Messages, this is always "message".
Accepts one of the following:
const MessageMessage Message = "message"
Usage BetaUsage
Usage BetaUsage
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
CacheCreation BetaCacheCreation
CacheCreation BetaCacheCreation
Breakdown of cached tokens by TTL
Ephemeral1hInputTokens int64
Ephemeral1hInputTokens int64
The number of input tokens used to create the 1 hour cache entry.
minimum0
Ephemeral5mInputTokens int64
Ephemeral5mInputTokens int64
The number of input tokens used to create the 5 minute cache entry.
minimum0
CacheCreationInputTokens int64
CacheCreationInputTokens int64
The number of input tokens used to create the cache entry.
minimum0
CacheReadInputTokens int64
CacheReadInputTokens int64
The number of input tokens read from the cache.
minimum0
InputTokens int64
InputTokens int64
The number of input tokens which were used.
minimum0
OutputTokens int64
OutputTokens int64
The number of output tokens which were used.
minimum0
ServerToolUse BetaServerToolUsage
ServerToolUse BetaServerToolUsage
The number of server tool requests.
WebFetchRequests int64
WebFetchRequests int64
The number of web fetch tool requests.
minimum0
WebSearchRequests int64
WebSearchRequests int64
The number of web search tool requests.
minimum0
ServiceTier BetaUsageServiceTier
ServiceTier BetaUsageServiceTier
If the request used the priority, standard, or batch tier.
Accepts one of the following:
const BetaUsageServiceTierStandard BetaUsageServiceTier = "standard"
const BetaUsageServiceTierPriority BetaUsageServiceTier = "priority"
const BetaUsageServiceTierBatch BetaUsageServiceTier = "batch"
Type Succeeded
Type Succeeded
Accepts one of the following:
const SucceededSucceeded Succeeded = "succeeded"