Beta
ModelsExpand Collapse
type AnthropicBeta interface{…}
type AnthropicBeta interface{…}
Accepts one of the following:
string
type AnthropicBeta string
type AnthropicBeta string
Accepts one of the following:
const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"
const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"
const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"
const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"
const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"
const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"
const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"
const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"
const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"
const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"
const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"
const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"
const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"
const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"
const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"
const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"
const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"
const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"
const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"
const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"
type BetaAPIError struct{…}
type BetaAPIError struct{…}
Message string
Type APIError
type BetaAuthenticationError struct{…}
type BetaAuthenticationError struct{…}
Message string
Type AuthenticationError
type BetaBillingError struct{…}
type BetaBillingError struct{…}
Message string
Type BillingError
type BetaErrorUnion interface{…}
type BetaErrorUnion interface{…}
Accepts one of the following:
type BetaInvalidRequestError struct{…}
type BetaInvalidRequestError struct{…}
Message string
Type InvalidRequestError
type BetaAuthenticationError struct{…}
type BetaAuthenticationError struct{…}
Message string
Type AuthenticationError
type BetaBillingError struct{…}
type BetaBillingError struct{…}
Message string
Type BillingError
type BetaPermissionError struct{…}
type BetaPermissionError struct{…}
Message string
Type PermissionError
type BetaNotFoundError struct{…}
type BetaNotFoundError struct{…}
Message string
Type NotFoundError
type BetaRateLimitError struct{…}
type BetaRateLimitError struct{…}
Message string
Type RateLimitError
type BetaGatewayTimeoutError struct{…}
type BetaGatewayTimeoutError struct{…}
Message string
Type TimeoutError
type BetaAPIError struct{…}
type BetaAPIError struct{…}
Message string
Type APIError
type BetaOverloadedError struct{…}
type BetaOverloadedError struct{…}
Message string
Type OverloadedError
type BetaErrorResponse struct{…}
type BetaErrorResponse struct{…}
Error BetaErrorUnion
Error BetaErrorUnion
Accepts one of the following:
type BetaInvalidRequestError struct{…}
type BetaInvalidRequestError struct{…}
Message string
Type InvalidRequestError
type BetaAuthenticationError struct{…}
type BetaAuthenticationError struct{…}
Message string
Type AuthenticationError
type BetaBillingError struct{…}
type BetaBillingError struct{…}
Message string
Type BillingError
type BetaPermissionError struct{…}
type BetaPermissionError struct{…}
Message string
Type PermissionError
type BetaNotFoundError struct{…}
type BetaNotFoundError struct{…}
Message string
Type NotFoundError
type BetaRateLimitError struct{…}
type BetaRateLimitError struct{…}
Message string
Type RateLimitError
type BetaGatewayTimeoutError struct{…}
type BetaGatewayTimeoutError struct{…}
Message string
Type TimeoutError
type BetaAPIError struct{…}
type BetaAPIError struct{…}
Message string
Type APIError
type BetaOverloadedError struct{…}
type BetaOverloadedError struct{…}
Message string
Type OverloadedError
RequestID string
Type Error
type BetaGatewayTimeoutError struct{…}
type BetaGatewayTimeoutError struct{…}
Message string
Type TimeoutError
type BetaInvalidRequestError struct{…}
type BetaInvalidRequestError struct{…}
Message string
Type InvalidRequestError
type BetaNotFoundError struct{…}
type BetaNotFoundError struct{…}
Message string
Type NotFoundError
type BetaOverloadedError struct{…}
type BetaOverloadedError struct{…}
Message string
Type OverloadedError
type BetaPermissionError struct{…}
type BetaPermissionError struct{…}
Message string
Type PermissionError
type BetaRateLimitError struct{…}
type BetaRateLimitError struct{…}
Message string
Type RateLimitError
BetaModels
Get a Model
client.Beta.Models.Get(ctx, modelID, query) (*BetaModelInfo, error)
GET/v1/models/{model_id}
ModelsExpand Collapse
type BetaModelInfo struct{…}
type BetaModelInfo struct{…}
ID string
Unique model identifier.
CreatedAt Time
RFC 3339 datetime string representing the time at which the model was released. May be set to an epoch value if the release date is unknown.
DisplayName string
A human-readable name for the model.
Type ModelObject type.
Type Model
Object type.
For Models, this is always "model".
BetaMessages
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 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 BetaBase64PDFSource struct{…}
type BetaBase64PDFSource struct{…}
Data string
MediaType ApplicationPDF
Type Base64
type BetaBashCodeExecutionOutputBlock struct{…}
type BetaBashCodeExecutionOutputBlock struct{…}
FileID string
Type BashCodeExecutionOutput
type BetaBashCodeExecutionOutputBlockParamResp struct{…}
type BetaBashCodeExecutionOutputBlockParamResp struct{…}
FileID string
Type BashCodeExecutionOutput
type BetaBashCodeExecutionResultBlock struct{…}
type BetaBashCodeExecutionResultBlock struct{…}
Content []BetaBashCodeExecutionOutputBlock
Content []BetaBashCodeExecutionOutputBlock
FileID string
Type BashCodeExecutionOutput
ReturnCode int64
Stderr string
Stdout string
Type BashCodeExecutionResult
type BetaBashCodeExecutionResultBlockParamResp struct{…}
type BetaBashCodeExecutionResultBlockParamResp struct{…}
FileID string
Type BashCodeExecutionOutput
ReturnCode int64
Stderr string
Stdout string
Type BashCodeExecutionResult
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 BetaBashCodeExecutionResultBlock struct{…}
type BetaBashCodeExecutionResultBlock struct{…}
Content []BetaBashCodeExecutionOutputBlock
Content []BetaBashCodeExecutionOutputBlock
FileID string
Type BashCodeExecutionOutput
ReturnCode int64
Stderr string
Stdout string
Type BashCodeExecutionResult
ToolUseID string
Type BashCodeExecutionToolResult
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 BetaBashCodeExecutionResultBlockParamResp struct{…}
type BetaBashCodeExecutionResultBlockParamResp struct{…}
FileID string
Type BashCodeExecutionOutput
ReturnCode int64
Stderr string
Stdout string
Type BashCodeExecutionResult
ToolUseID string
Type BashCodeExecutionToolResult
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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 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 BetaCacheControlEphemeral struct{…}
type BetaCacheControlEphemeral struct{…}
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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
The number of input tokens used to create the 1 hour cache entry.
Ephemeral5mInputTokens int64
The number of input tokens used to create the 5 minute cache entry.
type BetaCitationCharLocation struct{…}
type BetaCitationCharLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
FileID string
StartCharIndex int64
Type CharLocation
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
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 BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
type BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
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 BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Type CitationsDelta
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
URL string
type BetaClearThinking20251015Edit struct{…}
type BetaClearThinking20251015Edit struct{…}
Type ClearThinking20251015
Keep BetaClearThinking20251015EditKeepUnionoptionalNumber of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed.
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
Value int64
type BetaAllThinkingTurns struct{…}
type BetaAllThinkingTurns struct{…}
Type All
All
type BetaClearThinking20251015EditResponse struct{…}
type BetaClearThinking20251015EditResponse struct{…}
ClearedInputTokens int64
Number of input tokens cleared by this edit.
ClearedThinkingTurns int64
Number of thinking turns that were cleared.
Type ClearThinking20251015
The type of context management edit applied.
type BetaClearToolUses20250919Edit struct{…}
type BetaClearToolUses20250919Edit struct{…}
Type ClearToolUses20250919
ClearAtLeast BetaInputTokensClearAtLeastoptionalMinimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed.
ClearAtLeast BetaInputTokensClearAtLeastoptional
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
Value int64
ClearToolInputs BetaClearToolUses20250919EditClearToolInputsUnionoptionalWhether to clear all tool inputs (bool) or specific tool inputs to clear (list)
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
Tool names whose uses are preserved from clearing
Keep BetaToolUsesKeepoptionalNumber of tool uses to retain in the conversation
Keep BetaToolUsesKeepoptional
Number of tool uses to retain in the conversation
Type ToolUses
Value int64
Trigger BetaClearToolUses20250919EditTriggerUnionoptionalCondition that triggers the context management strategy
Trigger BetaClearToolUses20250919EditTriggerUnionoptional
Condition that triggers the context management strategy
Accepts one of the following:
type BetaInputTokensTrigger struct{…}
type BetaInputTokensTrigger struct{…}
Type InputTokens
Value int64
type BetaToolUsesTrigger struct{…}
type BetaToolUsesTrigger struct{…}
Type ToolUses
Value int64
type BetaClearToolUses20250919EditResponse struct{…}
type BetaClearToolUses20250919EditResponse struct{…}
ClearedInputTokens int64
Number of input tokens cleared by this edit.
ClearedToolUses int64
Number of tool uses that were cleared.
Type ClearToolUses20250919
The type of context management edit applied.
type BetaCodeExecutionOutputBlock struct{…}
type BetaCodeExecutionOutputBlock struct{…}
FileID string
Type CodeExecutionOutput
type BetaCodeExecutionOutputBlockParamResp struct{…}
type BetaCodeExecutionOutputBlockParamResp struct{…}
FileID string
Type CodeExecutionOutput
type BetaCodeExecutionResultBlock struct{…}
type BetaCodeExecutionResultBlock struct{…}
Content []BetaCodeExecutionOutputBlock
Content []BetaCodeExecutionOutputBlock
FileID string
Type CodeExecutionOutput
ReturnCode int64
Stderr string
Stdout string
Type CodeExecutionResult
type BetaCodeExecutionResultBlockParamResp struct{…}
type BetaCodeExecutionResultBlockParamResp struct{…}
Content []BetaCodeExecutionOutputBlockParamResp
Content []BetaCodeExecutionOutputBlockParamResp
FileID string
Type CodeExecutionOutput
ReturnCode int64
Stderr string
Stdout string
Type CodeExecutionResult
type BetaCodeExecutionTool20250522 struct{…}
type BetaCodeExecutionTool20250522 struct{…}
Name CodeExecutionName of the tool.
Name CodeExecution
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Type CodeExecution20250522
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"
const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"
const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260120"
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Strict booloptional
When true, guarantees schema validation on tool names and inputs
type BetaCodeExecutionTool20250825 struct{…}
type BetaCodeExecutionTool20250825 struct{…}
Name CodeExecutionName of the tool.
Name CodeExecution
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Type CodeExecution20250825
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"
const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"
const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260120"
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Strict booloptional
When true, guarantees schema validation on tool names and inputs
type BetaCodeExecutionTool20260120 struct{…}Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
type BetaCodeExecutionTool20260120 struct{…}
Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
Name CodeExecutionName of the tool.
Name CodeExecution
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Type CodeExecution20260120
AllowedCallers []stringoptional
AllowedCallers []stringoptional
Accepts one of the following:
const BetaCodeExecutionTool20260120AllowedCallerDirect BetaCodeExecutionTool20260120AllowedCaller = "direct"
const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20250825"
const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260120"
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Strict booloptional
When true, guarantees schema validation on tool names and inputs
type BetaCodeExecutionToolResultBlock struct{…}
type BetaCodeExecutionToolResultBlock struct{…}
Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
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 BetaCodeExecutionResultBlock struct{…}
type BetaCodeExecutionResultBlock struct{…}
Content []BetaCodeExecutionOutputBlock
Content []BetaCodeExecutionOutputBlock
FileID string
Type CodeExecutionOutput
ReturnCode int64
Stderr string
Stdout string
Type CodeExecutionResult
type BetaEncryptedCodeExecutionResultBlock struct{…}Code execution result with encrypted stdout for PFC + web_search results.
type BetaEncryptedCodeExecutionResultBlock struct{…}
Code execution result with encrypted stdout for PFC + web_search results.
Content []BetaCodeExecutionOutputBlock
Content []BetaCodeExecutionOutputBlock
FileID string
Type CodeExecutionOutput
EncryptedStdout string
ReturnCode int64
Stderr string
Type EncryptedCodeExecutionResult
ToolUseID string
Type CodeExecutionToolResult
type BetaCodeExecutionToolResultBlockContentUnion interface{…}Code execution result with encrypted stdout for PFC + web_search results.
type BetaCodeExecutionToolResultBlockContentUnion interface{…}
Code execution result with encrypted stdout for PFC + web_search results.
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 BetaCodeExecutionResultBlock struct{…}
type BetaCodeExecutionResultBlock struct{…}
Content []BetaCodeExecutionOutputBlock
Content []BetaCodeExecutionOutputBlock
FileID string
Type CodeExecutionOutput
ReturnCode int64
Stderr string
Stdout string
Type CodeExecutionResult
type BetaEncryptedCodeExecutionResultBlock struct{…}Code execution result with encrypted stdout for PFC + web_search results.
type BetaEncryptedCodeExecutionResultBlock struct{…}
Code execution result with encrypted stdout for PFC + web_search results.
Content []BetaCodeExecutionOutputBlock
Content []BetaCodeExecutionOutputBlock
FileID string
Type CodeExecutionOutput
EncryptedStdout string
ReturnCode int64
Stderr string
Type EncryptedCodeExecutionResult
type BetaCodeExecutionToolResultBlockParamResp struct{…}
type BetaCodeExecutionToolResultBlockParamResp struct{…}
Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
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 BetaCodeExecutionResultBlockParamResp struct{…}
type BetaCodeExecutionResultBlockParamResp struct{…}
Content []BetaCodeExecutionOutputBlockParamResp
Content []BetaCodeExecutionOutputBlockParamResp
FileID string
Type CodeExecutionOutput
ReturnCode int64
Stderr string
Stdout string
Type CodeExecutionResult
type BetaEncryptedCodeExecutionResultBlockParamResp struct{…}Code execution result with encrypted stdout for PFC + web_search results.
type BetaEncryptedCodeExecutionResultBlockParamResp struct{…}
Code execution result with encrypted stdout for PFC + web_search results.
Content []BetaCodeExecutionOutputBlockParamResp
Content []BetaCodeExecutionOutputBlockParamResp
FileID string
Type CodeExecutionOutput
EncryptedStdout string
ReturnCode int64
Stderr string
Type EncryptedCodeExecutionResult
ToolUseID string
Type CodeExecutionToolResult
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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{…}Code execution result with encrypted stdout for PFC + web_search results.
type BetaCodeExecutionToolResultBlockParamContentUnionResp interface{…}
Code execution result with encrypted stdout for PFC + web_search results.
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 BetaCodeExecutionResultBlockParamResp struct{…}
type BetaCodeExecutionResultBlockParamResp struct{…}
Content []BetaCodeExecutionOutputBlockParamResp
Content []BetaCodeExecutionOutputBlockParamResp
FileID string
Type CodeExecutionOutput
ReturnCode int64
Stderr string
Stdout string
Type CodeExecutionResult
type BetaEncryptedCodeExecutionResultBlockParamResp struct{…}Code execution result with encrypted stdout for PFC + web_search results.
type BetaEncryptedCodeExecutionResultBlockParamResp struct{…}
Code execution result with encrypted stdout for PFC + web_search results.
Content []BetaCodeExecutionOutputBlockParamResp
Content []BetaCodeExecutionOutputBlockParamResp
FileID string
Type CodeExecutionOutput
EncryptedStdout string
ReturnCode int64
Stderr string
Type EncryptedCodeExecutionResult
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 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 BetaCompact20260112Edit struct{…}Automatically compact older context when reaching the configured trigger threshold.
type BetaCompact20260112Edit struct{…}
Automatically compact older context when reaching the configured trigger threshold.
Type Compact20260112
Instructions stringoptional
Additional instructions for summarization.
PauseAfterCompaction booloptional
Whether to pause after compaction and return the compaction block to the user.
Trigger BetaInputTokensTriggeroptionalWhen to trigger compaction. Defaults to 150000 input tokens.
Trigger BetaInputTokensTriggeroptional
When to trigger compaction. Defaults to 150000 input tokens.
Type InputTokens
Value int64
type BetaCompactionBlock struct{…}A compaction block returned when autocompact is triggered.
type BetaCompactionBlock struct{…}
A compaction block returned when autocompact is triggered.
When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops.
Content string
Summary of compacted content, or null if compaction failed
Type Compaction
type BetaCompactionBlockParamResp struct{…}A compaction block containing summary of previous context.
type BetaCompactionBlockParamResp struct{…}
A compaction block containing summary of previous context.
Users should round-trip these blocks from responses to subsequent requests to maintain context across compaction boundaries.
When content is None, the block represents a failed compaction. The server treats these as no-ops. Empty string content is not allowed.
Content string
Summary of previously compacted content, or null if compaction failed
Type Compaction
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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 BetaCompactionContentBlockDelta struct{…}
type BetaCompactionContentBlockDelta struct{…}
Content string
Type CompactionDelta
type BetaCompactionIterationUsage struct{…}Token usage for a compaction iteration.
type BetaCompactionIterationUsage struct{…}
Token usage for a compaction iteration.
CacheCreation BetaCacheCreationBreakdown of cached tokens by TTL
CacheCreation BetaCacheCreation
Breakdown of cached tokens by TTL
Ephemeral1hInputTokens int64
The number of input tokens used to create the 1 hour cache entry.
Ephemeral5mInputTokens int64
The number of input tokens used to create the 5 minute cache entry.
CacheCreationInputTokens int64
The number of input tokens used to create the cache entry.
CacheReadInputTokens int64
The number of input tokens read from the cache.
InputTokens int64
The number of input tokens which were used.
OutputTokens int64
The number of output tokens which were used.
Type Compaction
Usage for a compaction iteration
type BetaContainer struct{…}Information about the container used in the request (for the code execution tool)
type BetaContainer struct{…}
Information about the container used in the request (for the code execution tool)
ID string
Identifier for the container used in this request
ExpiresAt Time
The time at which the container will expire.
Skills []BetaSkillSkills loaded in the container
Skills []BetaSkill
Skills loaded in the container
SkillID string
Skill ID
Type BetaSkillTypeType of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
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
Skill version or 'latest' for most recent version
type BetaContainerParamsResp struct{…}Container parameters with skills to be loaded.
type BetaContainerParamsResp struct{…}
Container parameters with skills to be loaded.
ID stringoptional
Container id
Skills []BetaSkillParamsRespoptionalList of skills to load in the container
Skills []BetaSkillParamsRespoptional
List of skills to load in the container
SkillID string
Skill ID
Type BetaSkillParamsTypeType of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
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
Skill version or 'latest' for most recent version
type BetaContainerUploadBlock struct{…}Response model for a file uploaded to the container.
type BetaContainerUploadBlock struct{…}
Response model for a file uploaded to the container.
FileID string
Type ContainerUpload
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.
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
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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{…}Response model for a file uploaded to the container.
type BetaContentBlockUnion interface{…}
Response model for a file uploaded to the container.
Accepts one of the following:
type BetaTextBlock struct{…}
type BetaTextBlock struct{…}
Citations []BetaTextCitationUnionCitations supporting the text block.
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 BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Text string
Type Text
type BetaThinkingBlock struct{…}
type BetaThinkingBlock struct{…}
Signature string
Thinking string
Type Thinking
type BetaRedactedThinkingBlock struct{…}
type BetaRedactedThinkingBlock struct{…}
Data string
Type RedactedThinking
type BetaToolUseBlock struct{…}
type BetaToolUseBlock struct{…}
ID string
Input map[string, any]
Name string
Type ToolUse
Caller BetaToolUseBlockCallerUnionoptionalTool invocation directly from the model.
Caller BetaToolUseBlockCallerUnionoptional
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}Tool invocation directly from the model.
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
type BetaServerToolCaller struct{…}Tool invocation generated by a server-side tool.
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
type BetaServerToolCaller20260120 struct{…}
type BetaServerToolCaller20260120 struct{…}
ToolID string
Type CodeExecution20260120
type BetaServerToolUseBlock struct{…}
type BetaServerToolUseBlock struct{…}
ID string
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
Caller BetaServerToolUseBlockCallerUnionoptionalTool invocation directly from the model.
Caller BetaServerToolUseBlockCallerUnionoptional
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}Tool invocation directly from the model.
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
type BetaServerToolCaller struct{…}Tool invocation generated by a server-side tool.
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
type BetaServerToolCaller20260120 struct{…}
type BetaServerToolCaller20260120 struct{…}
ToolID string
Type CodeExecution20260120
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 BetaWebSearchToolResultErrorCodeUnavailable BetaWebSearchToolResultErrorCode = "unavailable"
const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"
const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"
const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"
const BetaWebSearchToolResultErrorCodeRequestTooLarge BetaWebSearchToolResultErrorCode = "request_too_large"
Type WebSearchToolResultError
type BetaWebSearchToolResultBlockContentArray []BetaWebSearchResultBlock
type BetaWebSearchToolResultBlockContentArray []BetaWebSearchResultBlock
EncryptedContent string
PageAge string
Title string
Type WebSearchResult
URL string
ToolUseID string
Type WebSearchToolResult
Caller BetaWebSearchToolResultBlockCallerUnionoptionalTool invocation directly from the model.
Caller BetaWebSearchToolResultBlockCallerUnionoptional
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}Tool invocation directly from the model.
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
type BetaServerToolCaller struct{…}Tool invocation generated by a server-side tool.
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
type BetaServerToolCaller20260120 struct{…}
type BetaServerToolCaller20260120 struct{…}
ToolID string
Type CodeExecution20260120
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 BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"
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"
const BetaWebFetchToolResultErrorCodeUnavailable BetaWebFetchToolResultErrorCode = "unavailable"
Type WebFetchToolResultError
type BetaWebFetchBlock struct{…}
type BetaWebFetchBlock struct{…}
Content BetaDocumentBlock
Content BetaDocumentBlock
Citations BetaCitationConfigCitation configuration for the document
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
Type Base64
type BetaPlainTextSource struct{…}
type BetaPlainTextSource struct{…}
Data string
MediaType TextPlain
Type Text
Title string
The title of the document
Type Document
RetrievedAt string
ISO 8601 timestamp when the content was retrieved
Type WebFetchResult
URL string
Fetched content URL
ToolUseID string
Type WebFetchToolResult
Caller BetaWebFetchToolResultBlockCallerUnionoptionalTool invocation directly from the model.
Caller BetaWebFetchToolResultBlockCallerUnionoptional
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}Tool invocation directly from the model.
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
type BetaServerToolCaller struct{…}Tool invocation generated by a server-side tool.
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
type BetaServerToolCaller20260120 struct{…}
type BetaServerToolCaller20260120 struct{…}
ToolID string
Type CodeExecution20260120
type BetaCodeExecutionToolResultBlock struct{…}
type BetaCodeExecutionToolResultBlock struct{…}
Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
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 BetaCodeExecutionResultBlock struct{…}
type BetaCodeExecutionResultBlock struct{…}
Content []BetaCodeExecutionOutputBlock
Content []BetaCodeExecutionOutputBlock
FileID string
Type CodeExecutionOutput
ReturnCode int64
Stderr string
Stdout string
Type CodeExecutionResult
type BetaEncryptedCodeExecutionResultBlock struct{…}Code execution result with encrypted stdout for PFC + web_search results.
type BetaEncryptedCodeExecutionResultBlock struct{…}
Code execution result with encrypted stdout for PFC + web_search results.
Content []BetaCodeExecutionOutputBlock
Content []BetaCodeExecutionOutputBlock
FileID string
Type CodeExecutionOutput
EncryptedStdout string
ReturnCode int64
Stderr string
Type EncryptedCodeExecutionResult
ToolUseID string
Type CodeExecutionToolResult
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 BetaBashCodeExecutionResultBlock struct{…}
type BetaBashCodeExecutionResultBlock struct{…}
Content []BetaBashCodeExecutionOutputBlock
Content []BetaBashCodeExecutionOutputBlock
FileID string
Type BashCodeExecutionOutput
ReturnCode int64
Stderr string
Stdout string
Type BashCodeExecutionResult
ToolUseID string
Type BashCodeExecutionToolResult
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 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 BetaTextEditorCodeExecutionCreateResultBlock struct{…}
type BetaTextEditorCodeExecutionCreateResultBlock struct{…}
IsFileUpdate bool
Type TextEditorCodeExecutionCreateResult
type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}
type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}
Lines []string
NewLines int64
NewStart int64
OldLines int64
OldStart int64
Type TextEditorCodeExecutionStrReplaceResult
ToolUseID string
Type TextEditorCodeExecutionToolResult
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 BetaToolSearchToolSearchResultBlock struct{…}
type BetaToolSearchToolSearchResultBlock struct{…}
ToolReferences []BetaToolReferenceBlock
ToolReferences []BetaToolReferenceBlock
ToolName string
Type ToolReference
Type ToolSearchToolSearchResult
ToolUseID string
Type ToolSearchToolResult
type BetaMCPToolUseBlock struct{…}
type BetaMCPToolUseBlock struct{…}
ID string
Input map[string, any]
Name string
The name of the MCP tool
ServerName string
The name of the MCP server
Type MCPToolUse
type BetaMCPToolResultBlock struct{…}
type BetaMCPToolResultBlock struct{…}
Content BetaMCPToolResultBlockContentUnion
Content BetaMCPToolResultBlockContentUnion
Accepts one of the following:
string
type BetaMCPToolResultBlockContentBetaMCPToolResultBlockContent []BetaTextBlock
type BetaMCPToolResultBlockContentBetaMCPToolResultBlockContent []BetaTextBlock
Citations []BetaTextCitationUnionCitations supporting the text block.
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 BetaCitationPageLocation struct{…}
type BetaCitationPageLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
FileID string
StartPageNumber int64
Type PageLocation
type BetaCitationContentBlockLocation struct{…}
type BetaCitationContentBlockLocation struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
FileID string
StartBlockIndex int64
Type ContentBlockLocation
type BetaCitationsWebSearchResultLocation struct{…}
type BetaCitationsWebSearchResultLocation struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
URL string
type BetaCitationSearchResultLocation struct{…}
type BetaCitationSearchResultLocation struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Text string
Type Text
IsError bool
ToolUseID string
Type MCPToolResult
type BetaContainerUploadBlock struct{…}Response model for a file uploaded to the container.
type BetaContainerUploadBlock struct{…}
Response model for a file uploaded to the container.
FileID string
Type ContainerUpload
type BetaCompactionBlock struct{…}A compaction block returned when autocompact is triggered.
type BetaCompactionBlock struct{…}
A compaction block returned when autocompact is triggered.
When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops.
Content string
Summary of compacted content, or null if compaction failed
Type Compaction
type BetaContentBlockParamUnionResp interface{…}Regular text content.
type BetaContentBlockParamUnionResp interface{…}
Regular text content.
Accepts one of the following:
type BetaTextBlockParamResp struct{…}
type BetaTextBlockParamResp struct{…}
Text string
Type Text
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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 []BetaTextCitationParamUnionRespoptional
Citations []BetaTextCitationParamUnionRespoptional
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
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 BetaURLImageSource struct{…}
type BetaURLImageSource struct{…}
Type URL
URL string
type BetaFileImageSource struct{…}
type BetaFileImageSource struct{…}
FileID string
Type File
Type Image
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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
Type Base64
type BetaPlainTextSource struct{…}
type BetaPlainTextSource struct{…}
Data string
MediaType TextPlain
Type 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
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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 []BetaTextCitationParamUnionRespoptional
Citations []BetaTextCitationParamUnionRespoptional
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
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 BetaURLImageSource struct{…}
type BetaURLImageSource struct{…}
Type URL
URL string
type BetaFileImageSource struct{…}
type BetaFileImageSource struct{…}
FileID string
Type File
Type Image
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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 BetaURLPDFSource struct{…}
type BetaURLPDFSource struct{…}
Type URL
URL string
type BetaFileDocumentSource struct{…}
type BetaFileDocumentSource struct{…}
FileID string
Type File
Type Document
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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 BetaCitationsConfigParamRespoptional
Citations BetaCitationsConfigParamRespoptional
Enabled booloptional
Context stringoptional
Title stringoptional
type BetaSearchResultBlockParamResp struct{…}
type BetaSearchResultBlockParamResp struct{…}
Content []BetaTextBlockParamResp
Content []BetaTextBlockParamResp
Text string
Type Text
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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 []BetaTextCitationParamUnionRespoptional
Citations []BetaTextCitationParamUnionRespoptional
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Source string
Title string
Type SearchResult
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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 BetaCitationsConfigParamRespoptional
Citations BetaCitationsConfigParamRespoptional
Enabled booloptional
type BetaThinkingBlockParamResp struct{…}
type BetaThinkingBlockParamResp struct{…}
Signature string
Thinking string
Type Thinking
type BetaRedactedThinkingBlockParamResp struct{…}
type BetaRedactedThinkingBlockParamResp struct{…}
Data string
Type RedactedThinking
type BetaToolUseBlockParamResp struct{…}
type BetaToolUseBlockParamResp struct{…}
ID string
Input map[string, any]
Name string
Type ToolUse
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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 BetaToolUseBlockParamCallerUnionRespoptionalTool invocation directly from the model.
Caller BetaToolUseBlockParamCallerUnionRespoptional
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}Tool invocation directly from the model.
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
type BetaServerToolCaller struct{…}Tool invocation generated by a server-side tool.
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
type BetaServerToolCaller20260120 struct{…}
type BetaServerToolCaller20260120 struct{…}
ToolID string
Type CodeExecution20260120
type BetaToolResultBlockParamResp struct{…}
type BetaToolResultBlockParamResp struct{…}
ToolUseID string
Type ToolResult
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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 []BetaTextCitationParamUnionRespoptional
Citations []BetaTextCitationParamUnionRespoptional
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
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 BetaURLImageSource struct{…}
type BetaURLImageSource struct{…}
Type URL
URL string
type BetaFileImageSource struct{…}
type BetaFileImageSource struct{…}
FileID string
Type File
Type Image
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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 []BetaTextCitationParamUnionRespoptional
Citations []BetaTextCitationParamUnionRespoptional
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
Source string
Title string
Type SearchResult
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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 BetaCitationsConfigParamRespoptional
Citations BetaCitationsConfigParamRespoptional
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
Type Base64
type BetaPlainTextSource struct{…}
type BetaPlainTextSource struct{…}
Data string
MediaType TextPlain
Type 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
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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 []BetaTextCitationParamUnionRespoptional
Citations []BetaTextCitationParamUnionRespoptional
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
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 BetaURLImageSource struct{…}
type BetaURLImageSource struct{…}
Type URL
URL string
type BetaFileImageSource struct{…}
type BetaFileImageSource struct{…}
FileID string
Type File
Type Image
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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 BetaURLPDFSource struct{…}
type BetaURLPDFSource struct{…}
Type URL
URL string
type BetaFileDocumentSource struct{…}
type BetaFileDocumentSource struct{…}
FileID string
Type File
Type Document
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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 BetaCitationsConfigParamRespoptional
Citations BetaCitationsConfigParamRespoptional
Enabled booloptional
Context stringoptional
Title stringoptional
type BetaToolReferenceBlockParamResp struct{…}Tool reference block that can be included in tool_result content.
type BetaToolReferenceBlockParamResp struct{…}
Tool reference block that can be included in tool_result content.
ToolName string
Type ToolReference
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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 BetaServerToolUseBlockParamCallerUnionRespoptionalTool invocation directly from the model.
Caller BetaServerToolUseBlockParamCallerUnionRespoptional
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}Tool invocation directly from the model.
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
type BetaServerToolCaller struct{…}Tool invocation generated by a server-side tool.
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
type BetaServerToolCaller20260120 struct{…}
type BetaServerToolCaller20260120 struct{…}
ToolID string
Type CodeExecution20260120
type BetaWebSearchToolResultBlockParamResp struct{…}
type BetaWebSearchToolResultBlockParamResp struct{…}
Accepts one of the following:
EncryptedContent string
Title string
Type WebSearchResult
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 BetaWebSearchToolResultErrorCodeUnavailable BetaWebSearchToolResultErrorCode = "unavailable"
const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"
const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"
const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"
const BetaWebSearchToolResultErrorCodeRequestTooLarge BetaWebSearchToolResultErrorCode = "request_too_large"
Type WebSearchToolResultError
ToolUseID string
Type WebSearchToolResult
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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 BetaWebSearchToolResultBlockParamCallerUnionRespoptionalTool invocation directly from the model.
Caller BetaWebSearchToolResultBlockParamCallerUnionRespoptional
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}Tool invocation directly from the model.
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
type BetaServerToolCaller struct{…}Tool invocation generated by a server-side tool.
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
type BetaServerToolCaller20260120 struct{…}
type BetaServerToolCaller20260120 struct{…}
ToolID string
Type CodeExecution20260120
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 BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"
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"
const BetaWebFetchToolResultErrorCodeUnavailable BetaWebFetchToolResultErrorCode = "unavailable"
Type WebFetchToolResultError
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
Type Base64
type BetaPlainTextSource struct{…}
type BetaPlainTextSource struct{…}
Data string
MediaType TextPlain
Type 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
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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 []BetaTextCitationParamUnionRespoptional
Citations []BetaTextCitationParamUnionRespoptional
Accepts one of the following:
type BetaCitationCharLocationParamResp struct{…}
type BetaCitationCharLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndCharIndex int64
StartCharIndex int64
Type CharLocation
type BetaCitationPageLocationParamResp struct{…}
type BetaCitationPageLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndPageNumber int64
StartPageNumber int64
Type PageLocation
type BetaCitationContentBlockLocationParamResp struct{…}
type BetaCitationContentBlockLocationParamResp struct{…}
CitedText string
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64
StartBlockIndex int64
Type ContentBlockLocation
type BetaCitationWebSearchResultLocationParamResp struct{…}
type BetaCitationWebSearchResultLocationParamResp struct{…}
CitedText string
EncryptedIndex string
Title string
Type WebSearchResultLocation
URL string
type BetaCitationSearchResultLocationParamResp struct{…}
type BetaCitationSearchResultLocationParamResp struct{…}
CitedText string
EndBlockIndex int64
SearchResultIndex int64
Source string
StartBlockIndex int64
Title string
Type SearchResultLocation
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 BetaURLImageSource struct{…}
type BetaURLImageSource struct{…}
Type URL
URL string
type BetaFileImageSource struct{…}
type BetaFileImageSource struct{…}
FileID string
Type File
Type Image
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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 BetaURLPDFSource struct{…}
type BetaURLPDFSource struct{…}
Type URL
URL string
type BetaFileDocumentSource struct{…}
type BetaFileDocumentSource struct{…}
FileID string
Type File
Type Document
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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 BetaCitationsConfigParamRespoptional
Citations BetaCitationsConfigParamRespoptional
Enabled booloptional
Context stringoptional
Title stringoptional
Type WebFetchResult
URL string
Fetched content URL
RetrievedAt stringoptional
ISO 8601 timestamp when the content was retrieved
ToolUseID string
Type WebFetchToolResult
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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 BetaWebFetchToolResultBlockParamCallerUnionRespoptionalTool invocation directly from the model.
Caller BetaWebFetchToolResultBlockParamCallerUnionRespoptional
Tool invocation directly from the model.
Accepts one of the following:
type BetaDirectCaller struct{…}Tool invocation directly from the model.
type BetaDirectCaller struct{…}
Tool invocation directly from the model.
Type Direct
type BetaServerToolCaller struct{…}Tool invocation generated by a server-side tool.
type BetaServerToolCaller struct{…}
Tool invocation generated by a server-side tool.
ToolID string
Type CodeExecution20250825
type BetaServerToolCaller20260120 struct{…}
type BetaServerToolCaller20260120 struct{…}
ToolID string
Type CodeExecution20260120
type BetaCodeExecutionToolResultBlockParamResp struct{…}
type BetaCodeExecutionToolResultBlockParamResp struct{…}
Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
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 BetaCodeExecutionResultBlockParamResp struct{…}
type BetaCodeExecutionResultBlockParamResp struct{…}
Content []BetaCodeExecutionOutputBlockParamResp
Content []BetaCodeExecutionOutputBlockParamResp
FileID string
Type CodeExecutionOutput
ReturnCode int64
Stderr string
Stdout string
Type CodeExecutionResult
type BetaEncryptedCodeExecutionResultBlockParamResp struct{…}Code execution result with encrypted stdout for PFC + web_search results.
type BetaEncryptedCodeExecutionResultBlockParamResp struct{…}
Code execution result with encrypted stdout for PFC + web_search results.
Content []BetaCodeExecutionOutputBlockParamResp
Content []BetaCodeExecutionOutputBlockParamResp
FileID string
Type CodeExecutionOutput
EncryptedStdout string
ReturnCode int64
Stderr string
Type EncryptedCodeExecutionResult
ToolUseID string
Type CodeExecutionToolResult
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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 BetaBashCodeExecutionResultBlockParamResp struct{…}
type BetaBashCodeExecutionResultBlockParamResp struct{…}
FileID string
Type BashCodeExecutionOutput
ReturnCode int64
Stderr string
Stdout string
Type BashCodeExecutionResult
ToolUseID string
Type BashCodeExecutionToolResult
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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
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
NumLines int64optional
StartLine int64optional
TotalLines int64optional
type BetaTextEditorCodeExecutionCreateResultBlockParamResp struct{…}
type BetaTextEditorCodeExecutionCreateResultBlockParamResp struct{…}
IsFileUpdate bool
Type TextEditorCodeExecutionCreateResult
type BetaTextEditorCodeExecutionStrReplaceResultBlockParamResp struct{…}
type BetaTextEditorCodeExecutionStrReplaceResultBlockParamResp struct{…}
Type TextEditorCodeExecutionStrReplaceResult
Lines []stringoptional
NewLines int64optional
NewStart int64optional
OldLines int64optional
OldStart int64optional
ToolUseID string
Type TextEditorCodeExecutionToolResult
CacheControl BetaCacheControlEphemeraloptionalCreate a cache control breakpoint at this content block.
CacheControl BetaCacheControlEphemeraloptional
Create a cache control breakpoint at this content block.
Type Ephemeral
TTL BetaCacheControlEphemeralTTLoptionalThe time-to-live for the cache control breakpoint.
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