# Beta ## Domain Types ### Anthropic Beta - `type AnthropicBeta interface{…}` - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Beta API Error - `type BetaAPIError struct{…}` - `Message string` - `Type APIError` - `const APIErrorAPIError APIError = "api_error"` ### Beta Authentication Error - `type BetaAuthenticationError struct{…}` - `Message string` - `Type AuthenticationError` - `const AuthenticationErrorAuthenticationError AuthenticationError = "authentication_error"` ### Beta Billing Error - `type BetaBillingError struct{…}` - `Message string` - `Type BillingError` - `const BillingErrorBillingError BillingError = "billing_error"` ### Beta Error - `type BetaErrorUnion interface{…}` - `type BetaInvalidRequestError struct{…}` - `Message string` - `Type InvalidRequestError` - `const InvalidRequestErrorInvalidRequestError InvalidRequestError = "invalid_request_error"` - `type BetaAuthenticationError struct{…}` - `Message string` - `Type AuthenticationError` - `const AuthenticationErrorAuthenticationError AuthenticationError = "authentication_error"` - `type BetaBillingError struct{…}` - `Message string` - `Type BillingError` - `const BillingErrorBillingError BillingError = "billing_error"` - `type BetaPermissionError struct{…}` - `Message string` - `Type PermissionError` - `const PermissionErrorPermissionError PermissionError = "permission_error"` - `type BetaNotFoundError struct{…}` - `Message string` - `Type NotFoundError` - `const NotFoundErrorNotFoundError NotFoundError = "not_found_error"` - `type BetaRateLimitError struct{…}` - `Message string` - `Type RateLimitError` - `const RateLimitErrorRateLimitError RateLimitError = "rate_limit_error"` - `type BetaGatewayTimeoutError struct{…}` - `Message string` - `Type TimeoutError` - `const TimeoutErrorTimeoutError TimeoutError = "timeout_error"` - `type BetaAPIError struct{…}` - `Message string` - `Type APIError` - `const APIErrorAPIError APIError = "api_error"` - `type BetaOverloadedError struct{…}` - `Message string` - `Type OverloadedError` - `const OverloadedErrorOverloadedError OverloadedError = "overloaded_error"` ### Beta Error Response - `type BetaErrorResponse struct{…}` - `Error BetaErrorUnion` - `type BetaInvalidRequestError struct{…}` - `Message string` - `Type InvalidRequestError` - `const InvalidRequestErrorInvalidRequestError InvalidRequestError = "invalid_request_error"` - `type BetaAuthenticationError struct{…}` - `Message string` - `Type AuthenticationError` - `const AuthenticationErrorAuthenticationError AuthenticationError = "authentication_error"` - `type BetaBillingError struct{…}` - `Message string` - `Type BillingError` - `const BillingErrorBillingError BillingError = "billing_error"` - `type BetaPermissionError struct{…}` - `Message string` - `Type PermissionError` - `const PermissionErrorPermissionError PermissionError = "permission_error"` - `type BetaNotFoundError struct{…}` - `Message string` - `Type NotFoundError` - `const NotFoundErrorNotFoundError NotFoundError = "not_found_error"` - `type BetaRateLimitError struct{…}` - `Message string` - `Type RateLimitError` - `const RateLimitErrorRateLimitError RateLimitError = "rate_limit_error"` - `type BetaGatewayTimeoutError struct{…}` - `Message string` - `Type TimeoutError` - `const TimeoutErrorTimeoutError TimeoutError = "timeout_error"` - `type BetaAPIError struct{…}` - `Message string` - `Type APIError` - `const APIErrorAPIError APIError = "api_error"` - `type BetaOverloadedError struct{…}` - `Message string` - `Type OverloadedError` - `const OverloadedErrorOverloadedError OverloadedError = "overloaded_error"` - `RequestID string` - `Type Error` - `const ErrorError Error = "error"` ### Beta Gateway Timeout Error - `type BetaGatewayTimeoutError struct{…}` - `Message string` - `Type TimeoutError` - `const TimeoutErrorTimeoutError TimeoutError = "timeout_error"` ### Beta Invalid Request Error - `type BetaInvalidRequestError struct{…}` - `Message string` - `Type InvalidRequestError` - `const InvalidRequestErrorInvalidRequestError InvalidRequestError = "invalid_request_error"` ### Beta Not Found Error - `type BetaNotFoundError struct{…}` - `Message string` - `Type NotFoundError` - `const NotFoundErrorNotFoundError NotFoundError = "not_found_error"` ### Beta Overloaded Error - `type BetaOverloadedError struct{…}` - `Message string` - `Type OverloadedError` - `const OverloadedErrorOverloadedError OverloadedError = "overloaded_error"` ### Beta Permission Error - `type BetaPermissionError struct{…}` - `Message string` - `Type PermissionError` - `const PermissionErrorPermissionError PermissionError = "permission_error"` ### Beta Rate Limit Error - `type BetaRateLimitError struct{…}` - `Message string` - `Type RateLimitError` - `const RateLimitErrorRateLimitError RateLimitError = "rate_limit_error"` # Models ## List Models `client.Beta.Models.List(ctx, params) (*Page[BetaModelInfo], error)` **get** `/v1/models` List available models. The Models API response can be used to determine which models are available for use in the API. More recently released models are listed first. ### Parameters - `params BetaModelListParams` - `AfterID param.Field[string]` Query param: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. - `BeforeID param.Field[string]` Query param: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. - `Limit param.Field[int64]` Query param: Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaModelInfo struct{…}` - `ID string` Unique model identifier. - `Capabilities BetaModelCapabilities` Model capability information. - `Batch BetaCapabilitySupport` Whether the model supports the Batch API. - `Supported bool` Whether this capability is supported by the model. - `Citations BetaCapabilitySupport` Whether the model supports citation generation. - `CodeExecution BetaCapabilitySupport` Whether the model supports code execution tools. - `ContextManagement BetaContextManagementCapability` Context management support and available strategies. - `ClearThinking20251015 BetaCapabilitySupport` Indicates whether a capability is supported. - `ClearToolUses20250919 BetaCapabilitySupport` Indicates whether a capability is supported. - `Compact20260112 BetaCapabilitySupport` Indicates whether a capability is supported. - `Supported bool` Whether this capability is supported by the model. - `Effort BetaEffortCapability` Effort (reasoning_effort) support and available levels. - `High BetaCapabilitySupport` Whether the model supports high effort level. - `Low BetaCapabilitySupport` Whether the model supports low effort level. - `Max BetaCapabilitySupport` Whether the model supports max effort level. - `Medium BetaCapabilitySupport` Whether the model supports medium effort level. - `Supported bool` Whether this capability is supported by the model. - `Xhigh BetaCapabilitySupport` Indicates whether a capability is supported. - `ImageInput BetaCapabilitySupport` Whether the model accepts image content blocks. - `PDFInput BetaCapabilitySupport` Whether the model accepts PDF content blocks. - `StructuredOutputs BetaCapabilitySupport` Whether the model supports structured output / JSON mode / strict tool schemas. - `Thinking BetaThinkingCapability` Thinking capability and supported type configurations. - `Supported bool` Whether this capability is supported by the model. - `Types BetaThinkingTypes` Supported thinking type configurations. - `Adaptive BetaCapabilitySupport` Whether the model supports thinking with type 'adaptive' (auto). - `Enabled BetaCapabilitySupport` Whether the model supports thinking with type 'enabled'. - `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. - `MaxInputTokens int64` Maximum input context window size in tokens for this model. - `MaxTokens int64` Maximum value for the `max_tokens` parameter when using this model. - `Type Model` Object type. For Models, this is always `"model"`. - `const ModelModel Model = "model"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) page, err := client.Beta.Models.List(context.TODO(), anthropic.BetaModelListParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "data": [ { "id": "claude-opus-4-6", "capabilities": { "batch": { "supported": true }, "citations": { "supported": true }, "code_execution": { "supported": true }, "context_management": { "clear_thinking_20251015": { "supported": true }, "clear_tool_uses_20250919": { "supported": true }, "compact_20260112": { "supported": true }, "supported": true }, "effort": { "high": { "supported": true }, "low": { "supported": true }, "max": { "supported": true }, "medium": { "supported": true }, "supported": true, "xhigh": { "supported": true } }, "image_input": { "supported": true }, "pdf_input": { "supported": true }, "structured_outputs": { "supported": true }, "thinking": { "supported": true, "types": { "adaptive": { "supported": true }, "enabled": { "supported": true } } } }, "created_at": "2026-02-04T00:00:00Z", "display_name": "Claude Opus 4.6", "max_input_tokens": 0, "max_tokens": 0, "type": "model" } ], "first_id": "first_id", "has_more": true, "last_id": "last_id" } ``` ## Get a Model `client.Beta.Models.Get(ctx, modelID, query) (*BetaModelInfo, error)` **get** `/v1/models/{model_id}` Get a specific model. The Models API response can be used to determine information about a specific model or resolve a model alias to a model ID. ### Parameters - `modelID string` Model identifier or alias. - `query BetaModelGetParams` - `Betas param.Field[[]AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaModelInfo struct{…}` - `ID string` Unique model identifier. - `Capabilities BetaModelCapabilities` Model capability information. - `Batch BetaCapabilitySupport` Whether the model supports the Batch API. - `Supported bool` Whether this capability is supported by the model. - `Citations BetaCapabilitySupport` Whether the model supports citation generation. - `CodeExecution BetaCapabilitySupport` Whether the model supports code execution tools. - `ContextManagement BetaContextManagementCapability` Context management support and available strategies. - `ClearThinking20251015 BetaCapabilitySupport` Indicates whether a capability is supported. - `ClearToolUses20250919 BetaCapabilitySupport` Indicates whether a capability is supported. - `Compact20260112 BetaCapabilitySupport` Indicates whether a capability is supported. - `Supported bool` Whether this capability is supported by the model. - `Effort BetaEffortCapability` Effort (reasoning_effort) support and available levels. - `High BetaCapabilitySupport` Whether the model supports high effort level. - `Low BetaCapabilitySupport` Whether the model supports low effort level. - `Max BetaCapabilitySupport` Whether the model supports max effort level. - `Medium BetaCapabilitySupport` Whether the model supports medium effort level. - `Supported bool` Whether this capability is supported by the model. - `Xhigh BetaCapabilitySupport` Indicates whether a capability is supported. - `ImageInput BetaCapabilitySupport` Whether the model accepts image content blocks. - `PDFInput BetaCapabilitySupport` Whether the model accepts PDF content blocks. - `StructuredOutputs BetaCapabilitySupport` Whether the model supports structured output / JSON mode / strict tool schemas. - `Thinking BetaThinkingCapability` Thinking capability and supported type configurations. - `Supported bool` Whether this capability is supported by the model. - `Types BetaThinkingTypes` Supported thinking type configurations. - `Adaptive BetaCapabilitySupport` Whether the model supports thinking with type 'adaptive' (auto). - `Enabled BetaCapabilitySupport` Whether the model supports thinking with type 'enabled'. - `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. - `MaxInputTokens int64` Maximum input context window size in tokens for this model. - `MaxTokens int64` Maximum value for the `max_tokens` parameter when using this model. - `Type Model` Object type. For Models, this is always `"model"`. - `const ModelModel Model = "model"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaModelInfo, err := client.Beta.Models.Get( context.TODO(), "model_id", anthropic.BetaModelGetParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaModelInfo.ID) } ``` #### Response ```json { "id": "claude-opus-4-6", "capabilities": { "batch": { "supported": true }, "citations": { "supported": true }, "code_execution": { "supported": true }, "context_management": { "clear_thinking_20251015": { "supported": true }, "clear_tool_uses_20250919": { "supported": true }, "compact_20260112": { "supported": true }, "supported": true }, "effort": { "high": { "supported": true }, "low": { "supported": true }, "max": { "supported": true }, "medium": { "supported": true }, "supported": true, "xhigh": { "supported": true } }, "image_input": { "supported": true }, "pdf_input": { "supported": true }, "structured_outputs": { "supported": true }, "thinking": { "supported": true, "types": { "adaptive": { "supported": true }, "enabled": { "supported": true } } } }, "created_at": "2026-02-04T00:00:00Z", "display_name": "Claude Opus 4.6", "max_input_tokens": 0, "max_tokens": 0, "type": "model" } ``` ## Domain Types ### Beta Capability Support - `type BetaCapabilitySupport struct{…}` Indicates whether a capability is supported. - `Supported bool` Whether this capability is supported by the model. ### Beta Context Management Capability - `type BetaContextManagementCapability struct{…}` Context management capability details. - `ClearThinking20251015 BetaCapabilitySupport` Indicates whether a capability is supported. - `Supported bool` Whether this capability is supported by the model. - `ClearToolUses20250919 BetaCapabilitySupport` Indicates whether a capability is supported. - `Compact20260112 BetaCapabilitySupport` Indicates whether a capability is supported. - `Supported bool` Whether this capability is supported by the model. ### Beta Effort Capability - `type BetaEffortCapability struct{…}` Effort (reasoning_effort) capability details. - `High BetaCapabilitySupport` Whether the model supports high effort level. - `Supported bool` Whether this capability is supported by the model. - `Low BetaCapabilitySupport` Whether the model supports low effort level. - `Max BetaCapabilitySupport` Whether the model supports max effort level. - `Medium BetaCapabilitySupport` Whether the model supports medium effort level. - `Supported bool` Whether this capability is supported by the model. - `Xhigh BetaCapabilitySupport` Indicates whether a capability is supported. ### Beta Model Capabilities - `type BetaModelCapabilities struct{…}` Model capability information. - `Batch BetaCapabilitySupport` Whether the model supports the Batch API. - `Supported bool` Whether this capability is supported by the model. - `Citations BetaCapabilitySupport` Whether the model supports citation generation. - `CodeExecution BetaCapabilitySupport` Whether the model supports code execution tools. - `ContextManagement BetaContextManagementCapability` Context management support and available strategies. - `ClearThinking20251015 BetaCapabilitySupport` Indicates whether a capability is supported. - `ClearToolUses20250919 BetaCapabilitySupport` Indicates whether a capability is supported. - `Compact20260112 BetaCapabilitySupport` Indicates whether a capability is supported. - `Supported bool` Whether this capability is supported by the model. - `Effort BetaEffortCapability` Effort (reasoning_effort) support and available levels. - `High BetaCapabilitySupport` Whether the model supports high effort level. - `Low BetaCapabilitySupport` Whether the model supports low effort level. - `Max BetaCapabilitySupport` Whether the model supports max effort level. - `Medium BetaCapabilitySupport` Whether the model supports medium effort level. - `Supported bool` Whether this capability is supported by the model. - `Xhigh BetaCapabilitySupport` Indicates whether a capability is supported. - `ImageInput BetaCapabilitySupport` Whether the model accepts image content blocks. - `PDFInput BetaCapabilitySupport` Whether the model accepts PDF content blocks. - `StructuredOutputs BetaCapabilitySupport` Whether the model supports structured output / JSON mode / strict tool schemas. - `Thinking BetaThinkingCapability` Thinking capability and supported type configurations. - `Supported bool` Whether this capability is supported by the model. - `Types BetaThinkingTypes` Supported thinking type configurations. - `Adaptive BetaCapabilitySupport` Whether the model supports thinking with type 'adaptive' (auto). - `Enabled BetaCapabilitySupport` Whether the model supports thinking with type 'enabled'. ### Beta Model Info - `type BetaModelInfo struct{…}` - `ID string` Unique model identifier. - `Capabilities BetaModelCapabilities` Model capability information. - `Batch BetaCapabilitySupport` Whether the model supports the Batch API. - `Supported bool` Whether this capability is supported by the model. - `Citations BetaCapabilitySupport` Whether the model supports citation generation. - `CodeExecution BetaCapabilitySupport` Whether the model supports code execution tools. - `ContextManagement BetaContextManagementCapability` Context management support and available strategies. - `ClearThinking20251015 BetaCapabilitySupport` Indicates whether a capability is supported. - `ClearToolUses20250919 BetaCapabilitySupport` Indicates whether a capability is supported. - `Compact20260112 BetaCapabilitySupport` Indicates whether a capability is supported. - `Supported bool` Whether this capability is supported by the model. - `Effort BetaEffortCapability` Effort (reasoning_effort) support and available levels. - `High BetaCapabilitySupport` Whether the model supports high effort level. - `Low BetaCapabilitySupport` Whether the model supports low effort level. - `Max BetaCapabilitySupport` Whether the model supports max effort level. - `Medium BetaCapabilitySupport` Whether the model supports medium effort level. - `Supported bool` Whether this capability is supported by the model. - `Xhigh BetaCapabilitySupport` Indicates whether a capability is supported. - `ImageInput BetaCapabilitySupport` Whether the model accepts image content blocks. - `PDFInput BetaCapabilitySupport` Whether the model accepts PDF content blocks. - `StructuredOutputs BetaCapabilitySupport` Whether the model supports structured output / JSON mode / strict tool schemas. - `Thinking BetaThinkingCapability` Thinking capability and supported type configurations. - `Supported bool` Whether this capability is supported by the model. - `Types BetaThinkingTypes` Supported thinking type configurations. - `Adaptive BetaCapabilitySupport` Whether the model supports thinking with type 'adaptive' (auto). - `Enabled BetaCapabilitySupport` Whether the model supports thinking with type 'enabled'. - `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. - `MaxInputTokens int64` Maximum input context window size in tokens for this model. - `MaxTokens int64` Maximum value for the `max_tokens` parameter when using this model. - `Type Model` Object type. For Models, this is always `"model"`. - `const ModelModel Model = "model"` ### Beta Thinking Capability - `type BetaThinkingCapability struct{…}` Thinking capability details. - `Supported bool` Whether this capability is supported by the model. - `Types BetaThinkingTypes` Supported thinking type configurations. - `Adaptive BetaCapabilitySupport` Whether the model supports thinking with type 'adaptive' (auto). - `Supported bool` Whether this capability is supported by the model. - `Enabled BetaCapabilitySupport` Whether the model supports thinking with type 'enabled'. ### Beta Thinking Types - `type BetaThinkingTypes struct{…}` Supported thinking type configurations. - `Adaptive BetaCapabilitySupport` Whether the model supports thinking with type 'adaptive' (auto). - `Supported bool` Whether this capability is supported by the model. - `Enabled BetaCapabilitySupport` Whether the model supports thinking with type 'enabled'. # Messages ## Create a Message `client.Beta.Messages.New(ctx, params) (*BetaMessage, error)` **post** `/v1/messages` Send a structured list of input messages with text and/or image content, and the model will generate the next message in the conversation. The Messages API can be used for either single queries or stateless multi-turn conversations. Learn more about the Messages API in our [user guide](https://docs.claude.com/en/docs/initial-setup) ### Parameters - `params BetaMessageNewParams` - `MaxTokens param.Field[int64]` Body param: The maximum number of tokens to generate before stopping. Note that our models may stop _before_ reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate. Set to `0` to populate the [prompt cache](https://docs.claude.com/en/docs/build-with-claude/prompt-caching#pre-warming-the-cache) without generating a response. Different models have different maximum values for this parameter. See [models](https://docs.claude.com/en/docs/models-overview) for details. - `Messages param.Field[[]BetaMessageParamResp]` Body param: Input messages. Our models are trained to operate on alternating `user` and `assistant` conversational turns. When creating a new `Message`, you specify the prior conversational turns with the `messages` parameter, and the model then generates the next `Message` in the conversation. Consecutive `user` or `assistant` turns in your request will be combined into a single turn. Each input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages. If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. Example with a single `user` message: ```json [{"role": "user", "content": "Hello, Claude"}] ``` Example with multiple conversational turns: ```json [ {"role": "user", "content": "Hello there."}, {"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"}, {"role": "user", "content": "Can you explain LLMs in plain English?"}, ] ``` Example with a partially-filled response from Claude: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("}, ] ``` Each input message `content` may be either a single `string` or an array of content blocks, where each block has a specific `type`. Using a `string` for `content` is shorthand for an array of one content block of type `"text"`. The following input messages are equivalent: ```json {"role": "user", "content": "Hello, Claude"} ``` ```json {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]} ``` See [input examples](https://docs.claude.com/en/api/messages-examples). Note that if you want to include a [system prompt](https://docs.claude.com/en/docs/system-prompts), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API. There is a limit of 100,000 messages in a single request. - `Content []BetaContentBlockParamUnionResp` - `[]BetaContentBlockParamUnionResp` - `type BetaTextBlockParamResp struct{…}` - `Text string` - `Type Text` - `const TextText Text = "text"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations []BetaTextCitationParamUnionResp` - `type BetaCitationCharLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationWebSearchResultLocationParamResp struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `type BetaImageBlockParamResp struct{…}` - `Source BetaImageBlockParamSourceUnionResp` - `type BetaBase64ImageSource struct{…}` - `Data string` - `MediaType BetaBase64ImageSourceMediaType` - `const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"` - `const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"` - `const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"` - `const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaURLImageSource struct{…}` - `Type URL` - `const URLURL URL = "url"` - `URL string` - `type BetaFileImageSource struct{…}` - `FileID string` - `Type File` - `const FileFile File = "file"` - `Type Image` - `const ImageImage Image = "image"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaRequestDocumentBlock struct{…}` - `Source BetaRequestDocumentBlockSourceUnion` - `type BetaBase64PDFSource struct{…}` - `Data string` - `MediaType ApplicationPDF` - `const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaPlainTextSource struct{…}` - `Data string` - `MediaType TextPlain` - `const TextPlainTextPlain TextPlain = "text/plain"` - `Type Text` - `const TextText Text = "text"` - `type BetaContentBlockSource struct{…}` - `Content BetaContentBlockSourceContentUnion` - `string` - `[]BetaContentBlockSourceContentUnion` - `type BetaTextBlockParamResp struct{…}` - `type BetaImageBlockParamResp struct{…}` - `Type Content` - `const ContentContent Content = "content"` - `type BetaURLPDFSource struct{…}` - `Type URL` - `const URLURL URL = "url"` - `URL string` - `type BetaFileDocumentSource struct{…}` - `FileID string` - `Type File` - `const FileFile File = "file"` - `Type Document` - `const DocumentDocument Document = "document"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` - `Enabled bool` - `Context string` - `Title string` - `type BetaSearchResultBlockParamResp struct{…}` - `Content []BetaTextBlockParamResp` - `Text string` - `Type Text` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnionResp` - `Source string` - `Title string` - `Type SearchResult` - `const SearchResultSearchResult SearchResult = "search_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` - `type BetaThinkingBlockParamResp struct{…}` - `Signature string` - `Thinking string` - `Type Thinking` - `const ThinkingThinking Thinking = "thinking"` - `type BetaRedactedThinkingBlockParamResp struct{…}` - `Data string` - `Type RedactedThinking` - `const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"` - `type BetaToolUseBlockParamResp struct{…}` - `ID string` - `Input map[string, any]` - `Name string` - `Type ToolUse` - `const ToolUseToolUse ToolUse = "tool_use"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Caller BetaToolUseBlockParamCallerUnionResp` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `Type Direct` - `const DirectDirect Direct = "direct"` - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `ToolID string` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `type BetaServerToolCaller20260120 struct{…}` - `ToolID string` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` - `type BetaToolResultBlockParamResp struct{…}` - `ToolUseID string` - `Type ToolResult` - `const ToolResultToolResult ToolResult = "tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Content []BetaToolResultBlockParamContentUnionResp` - `[]BetaToolResultBlockParamContentUnionResp` - `type BetaTextBlockParamResp struct{…}` - `type BetaImageBlockParamResp struct{…}` - `type BetaSearchResultBlockParamResp struct{…}` - `type BetaRequestDocumentBlock struct{…}` - `type BetaToolReferenceBlockParamResp struct{…}` Tool reference block that can be included in tool_result content. - `ToolName string` - `Type ToolReference` - `const ToolReferenceToolReference ToolReference = "tool_reference"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `IsError bool` - `type BetaServerToolUseBlockParamResp struct{…}` - `ID string` - `Input map[string, any]` - `Name BetaServerToolUseBlockParamName` - `const BetaServerToolUseBlockParamNameAdvisor BetaServerToolUseBlockParamName = "advisor"` - `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` - `const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Caller BetaServerToolUseBlockParamCallerUnionResp` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebSearchToolResultBlockParamResp struct{…}` - `Content BetaWebSearchToolResultBlockParamContentUnionResp` - `[]BetaWebSearchResultBlockParamResp` - `EncryptedContent string` - `Title string` - `Type WebSearchResult` - `const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"` - `URL string` - `PageAge string` - `type BetaWebSearchToolRequestError struct{…}` - `ErrorCode BetaWebSearchToolResultErrorCode` - `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` - `const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"` - `ToolUseID string` - `Type WebSearchToolResult` - `const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Caller BetaWebSearchToolResultBlockParamCallerUnionResp` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebFetchToolResultBlockParamResp struct{…}` - `Content BetaWebFetchToolResultBlockParamContentUnionResp` - `type BetaWebFetchToolResultErrorBlockParamResp struct{…}` - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `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` - `const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"` - `type BetaWebFetchBlockParamResp struct{…}` - `Content BetaRequestDocumentBlock` - `Type WebFetchResult` - `const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"` - `URL string` Fetched content URL - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved - `ToolUseID string` - `Type WebFetchToolResult` - `const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Caller BetaWebFetchToolResultBlockParamCallerUnionResp` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaAdvisorToolResultBlockParamResp struct{…}` - `Content BetaAdvisorToolResultBlockParamContentUnionResp` - `type BetaAdvisorToolResultErrorParamResp struct{…}` - `ErrorCode BetaAdvisorToolResultErrorParamErrorCode` - `const BetaAdvisorToolResultErrorParamErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorParamErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorParamErrorCodePromptTooLong BetaAdvisorToolResultErrorParamErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorParamErrorCodeTooManyRequests BetaAdvisorToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorParamErrorCodeOverloaded BetaAdvisorToolResultErrorParamErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorParamErrorCodeUnavailable BetaAdvisorToolResultErrorParamErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorParamErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorParamErrorCode = "execution_time_exceeded"` - `Type AdvisorToolResultError` - `const AdvisorToolResultErrorAdvisorToolResultError AdvisorToolResultError = "advisor_tool_result_error"` - `type BetaAdvisorResultBlockParamResp struct{…}` - `Text string` - `Type AdvisorResult` - `const AdvisorResultAdvisorResult AdvisorResult = "advisor_result"` - `StopReason string` - `type BetaAdvisorRedactedResultBlockParamResp struct{…}` - `EncryptedContent string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `Type AdvisorRedactedResult` - `const AdvisorRedactedResultAdvisorRedactedResult AdvisorRedactedResult = "advisor_redacted_result"` - `StopReason string` - `ToolUseID string` - `Type AdvisorToolResult` - `const AdvisorToolResultAdvisorToolResult AdvisorToolResult = "advisor_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaCodeExecutionToolResultBlockParamResp struct{…}` - `Content BetaCodeExecutionToolResultBlockParamContentUnionResp` Code execution result with encrypted stdout for PFC + web_search results. - `type BetaCodeExecutionToolResultErrorParamResp struct{…}` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `Type CodeExecutionToolResultError` - `const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"` - `type BetaCodeExecutionResultBlockParamResp struct{…}` - `Content []BetaCodeExecutionOutputBlockParamResp` - `FileID string` - `Type CodeExecutionOutput` - `const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type CodeExecutionResult` - `const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"` - `type BetaEncryptedCodeExecutionResultBlockParamResp struct{…}` Code execution result with encrypted stdout for PFC + web_search results. - `Content []BetaCodeExecutionOutputBlockParamResp` - `FileID string` - `Type CodeExecutionOutput` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `Type EncryptedCodeExecutionResult` - `const EncryptedCodeExecutionResultEncryptedCodeExecutionResult EncryptedCodeExecutionResult = "encrypted_code_execution_result"` - `ToolUseID string` - `Type CodeExecutionToolResult` - `const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaBashCodeExecutionToolResultBlockParamResp struct{…}` - `Content BetaBashCodeExecutionToolResultBlockParamContentUnionResp` - `type BetaBashCodeExecutionToolResultErrorParamResp struct{…}` - `ErrorCode BetaBashCodeExecutionToolResultErrorParamErrorCode` - `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` - `const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"` - `type BetaBashCodeExecutionResultBlockParamResp struct{…}` - `Content []BetaBashCodeExecutionOutputBlockParamResp` - `FileID string` - `Type BashCodeExecutionOutput` - `const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type BashCodeExecutionResult` - `const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"` - `ToolUseID string` - `Type BashCodeExecutionToolResult` - `const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaTextEditorCodeExecutionToolResultBlockParamResp struct{…}` - `Content BetaTextEditorCodeExecutionToolResultBlockParamContentUnionResp` - `type BetaTextEditorCodeExecutionToolResultErrorParamResp struct{…}` - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorParamErrorCode` - `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` - `const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"` - `ErrorMessage string` - `type BetaTextEditorCodeExecutionViewResultBlockParamResp struct{…}` - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockParamFileType` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeText BetaTextEditorCodeExecutionViewResultBlockParamFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeImage BetaTextEditorCodeExecutionViewResultBlockParamFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypePDF BetaTextEditorCodeExecutionViewResultBlockParamFileType = "pdf"` - `Type TextEditorCodeExecutionViewResult` - `const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` - `type BetaTextEditorCodeExecutionCreateResultBlockParamResp struct{…}` - `IsFileUpdate bool` - `Type TextEditorCodeExecutionCreateResult` - `const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"` - `type BetaTextEditorCodeExecutionStrReplaceResultBlockParamResp struct{…}` - `Type TextEditorCodeExecutionStrReplaceResult` - `const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"` - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` - `ToolUseID string` - `Type TextEditorCodeExecutionToolResult` - `const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaToolSearchToolResultBlockParamResp struct{…}` - `Content BetaToolSearchToolResultBlockParamContentUnionResp` - `type BetaToolSearchToolResultErrorParamResp struct{…}` - `ErrorCode BetaToolSearchToolResultErrorParamErrorCode` - `const BetaToolSearchToolResultErrorParamErrorCodeInvalidToolInput BetaToolSearchToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaToolSearchToolResultErrorParamErrorCodeUnavailable BetaToolSearchToolResultErrorParamErrorCode = "unavailable"` - `const BetaToolSearchToolResultErrorParamErrorCodeTooManyRequests BetaToolSearchToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaToolSearchToolResultErrorParamErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorParamErrorCode = "execution_time_exceeded"` - `Type ToolSearchToolResultError` - `const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"` - `type BetaToolSearchToolSearchResultBlockParamResp struct{…}` - `ToolReferences []BetaToolReferenceBlockParamResp` - `ToolName string` - `Type ToolReference` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type ToolSearchToolSearchResult` - `const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"` - `ToolUseID string` - `Type ToolSearchToolResult` - `const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaMCPToolUseBlockParamResp struct{…}` - `ID string` - `Input map[string, any]` - `Name string` - `ServerName string` The name of the MCP server - `Type MCPToolUse` - `const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaRequestMCPToolResultBlockParamResp struct{…}` - `ToolUseID string` - `Type MCPToolResult` - `const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Content BetaRequestMCPToolResultBlockParamContentUnionResp` - `string` - `[]BetaTextBlockParamResp` - `Text string` - `Type Text` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnionResp` - `IsError bool` - `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` - `const ContainerUploadContainerUpload ContainerUpload = "container_upload"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `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. - `Type Compaction` - `const CompactionCompaction Compaction = "compaction"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Content string` Summary of previously compacted content, or null if compaction failed - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `type BetaMidConversationSystemBlockParamResp struct{…}` System instructions that appear mid-conversation. Use this block to provide or update system-level instructions at a specific point in the conversation, rather than only via the top-level `system` parameter. - `Content []BetaTextBlockParamResp` System instruction text blocks. - `Text string` - `Type Text` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnionResp` - `Type MidConvSystem` - `const MidConvSystemMidConvSystem MidConvSystem = "mid_conv_system"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Role BetaMessageParamRole` - `const BetaMessageParamRoleUser BetaMessageParamRole = "user"` - `const BetaMessageParamRoleAssistant BetaMessageParamRole = "assistant"` - `const BetaMessageParamRoleSystem BetaMessageParamRole = "system"` - `Model param.Field[Model]` Body param: The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `CacheControl param.Field[BetaCacheControlEphemeral]` Body param: Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request. - `Container param.Field[BetaMessageNewParamsContainerUnion]` Body param: Container identifier for reuse across requests. - `type BetaContainerParamsResp struct{…}` Container parameters with skills to be loaded. - `ID string` Container id - `Skills []BetaSkillParamsResp` List of skills to load in the container - `SkillID string` Skill ID - `Type BetaSkillParamsType` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `const BetaSkillParamsTypeAnthropic BetaSkillParamsType = "anthropic"` - `const BetaSkillParamsTypeCustom BetaSkillParamsType = "custom"` - `Version string` Skill version or 'latest' for most recent version - `string` - `ContextManagement param.Field[BetaContextManagementConfig]` Body param: Context management configuration. This allows you to control how Claude manages context across multiple requests, such as whether to clear function results or not. - `Diagnostics param.Field[BetaDiagnosticsParamResp]` Body param: Request-level diagnostics. Currently carries the previous response id for prompt-cache divergence reporting. - `InferenceGeo param.Field[string]` Body param: Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used. - `MCPServers param.Field[[]BetaRequestMCPServerURLDefinition]` Body param: MCP servers to be utilized in this request - `Name string` - `Type URL` - `const URLURL URL = "url"` - `URL string` - `AuthorizationToken string` - `ToolConfiguration BetaRequestMCPServerToolConfiguration` - `AllowedTools []string` - `Enabled bool` - `Metadata param.Field[BetaMetadata]` Body param: An object describing metadata about the request. - `OutputConfig param.Field[BetaOutputConfig]` Body param: Configuration options for the model's output, such as the output format. - `OutputFormat param.Field[BetaJSONOutputFormat]` Body param: Deprecated: Use `output_config.format` instead. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) A schema to specify Claude's output format in responses. This parameter will be removed in a future release. - `ServiceTier param.Field[BetaMessageNewParamsServiceTier]` Body param: Determines whether to use priority capacity (if available) or standard capacity for this request. Anthropic offers different levels of service for your API requests. See [service-tiers](https://docs.claude.com/en/api/service-tiers) for details. - `const BetaMessageNewParamsServiceTierAuto BetaMessageNewParamsServiceTier = "auto"` - `const BetaMessageNewParamsServiceTierStandardOnly BetaMessageNewParamsServiceTier = "standard_only"` - `Speed param.Field[BetaMessageNewParamsSpeed]` Body param: The inference speed mode for this request. `"fast"` enables high output-tokens-per-second inference. - `const BetaMessageNewParamsSpeedStandard BetaMessageNewParamsSpeed = "standard"` - `const BetaMessageNewParamsSpeedFast BetaMessageNewParamsSpeed = "fast"` - `StopSequences param.Field[[]string]` Body param: Custom text sequences that will cause the model to stop generating. Our models will normally stop when they have naturally completed their turn, which will result in a response `stop_reason` of `"end_turn"`. If you want the model to stop generating when it encounters custom strings of text, you can use the `stop_sequences` parameter. If the model encounters one of the custom sequences, the response `stop_reason` value will be `"stop_sequence"` and the response `stop_sequence` value will contain the matched stop sequence. - `` - `System param.Field[[]BetaTextBlockParamResp]` Body param: System prompt. A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://docs.claude.com/en/docs/system-prompts). - `[]BetaTextBlockParam` - `Text string` - `Type Text` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnionResp` - `Temperature param.Field[float64]` Body param: Amount of randomness injected into the response. Defaults to `1.0`. Ranges from `0.0` to `1.0`. Use `temperature` closer to `0.0` for analytical / multiple choice, and closer to `1.0` for creative and generative tasks. Note that even with `temperature` of `0.0`, the results will not be fully deterministic. - `Thinking param.Field[BetaThinkingConfigParamUnionResp]` Body param: Configuration for enabling Claude's extended thinking. When enabled, responses include `thinking` content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your `max_tokens` limit. See [extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details. - `ToolChoice param.Field[BetaToolChoiceUnion]` Body param: How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. - `Tools param.Field[[]BetaToolUnion]` Body param: Definitions of tools that the model may use. If you include `tools` in your API request, the model may return `tool_use` content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using `tool_result` content blocks. There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://docs.claude.com/en/docs/agents-and-tools/tool-use/overview#server-tools), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://docs.claude.com/en/docs/agents-and-tools/tool-use/web-search-tool)). Each tool definition includes: * `name`: Name of the tool. * `description`: Optional, but strongly-recommended description of the tool. * `input_schema`: [JSON schema](https://json-schema.org/draft/2020-12) for the tool `input` shape that the model will produce in `tool_use` output content blocks. For example, if you defined `tools` as: ```json [ { "name": "get_stock_price", "description": "Get the current stock price for a given ticker symbol.", "input_schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "The stock ticker symbol, e.g. AAPL for Apple Inc." } }, "required": ["ticker"] } } ] ``` And then asked the model "What's the S&P 500 at today?", the model might produce `tool_use` content blocks in the response like this: ```json [ { "type": "tool_use", "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "name": "get_stock_price", "input": { "ticker": "^GSPC" } } ] ``` You might then run your `get_stock_price` tool with `{"ticker": "^GSPC"}` as an input, and return the following back to the model in a subsequent `user` message: ```json [ { "type": "tool_result", "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "content": "259.75 USD" } ] ``` Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output. See our [guide](https://docs.claude.com/en/docs/tool-use) for more details. - `type BetaTool struct{…}` - `InputSchema BetaToolInputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `const ObjectObject Object = "object"` - `Properties map[string, any]` - `Required []string` - `Name string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string` - `const BetaToolAllowedCallerDirect BetaToolAllowedCaller = "direct"` - `const BetaToolAllowedCallerCodeExecution20250825 BetaToolAllowedCaller = "code_execution_20250825"` - `const BetaToolAllowedCallerCodeExecution20260120 BetaToolAllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Description string` Description of what this tool does. Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema. - `EagerInputStreaming bool` Enable eager input streaming for this tool. When true, tool input parameters will be streamed incrementally as they are generated, and types will be inferred on-the-fly rather than buffering the full JSON output. When false, streaming is disabled for this tool even if the fine-grained-tool-streaming beta is active. When null (default), uses the default behavior based on beta headers. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `Type BetaToolType` - `const BetaToolTypeCustom BetaToolType = "custom"` - `type BetaToolBash20241022 struct{…}` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const BashBash Bash = "bash"` - `Type Bash20241022` - `const Bash20241022Bash20241022 Bash20241022 = "bash_20241022"` - `AllowedCallers []string` - `const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"` - `const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260120 BetaToolBash20241022AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20250124 struct{…}` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const BashBash Bash = "bash"` - `Type Bash20250124` - `const Bash20250124Bash20250124 Bash20250124 = "bash_20250124"` - `AllowedCallers []string` - `const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"` - `const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260120 BetaToolBash20250124AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250522 struct{…}` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const CodeExecutionCodeExecution CodeExecution = "code_execution"` - `Type CodeExecution20250522` - `const CodeExecution20250522CodeExecution20250522 CodeExecution20250522 = "code_execution_20250522"` - `AllowedCallers []string` - `const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250825 struct{…}` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const CodeExecutionCodeExecution CodeExecution = "code_execution"` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `AllowedCallers []string` - `const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260120 struct{…}` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const CodeExecutionCodeExecution CodeExecution = "code_execution"` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` - `AllowedCallers []string` - `const BetaCodeExecutionTool20260120AllowedCallerDirect BetaCodeExecutionTool20260120AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20241022 struct{…}` - `DisplayHeightPx int64` The height of the display in pixels. - `DisplayWidthPx int64` The width of the display in pixels. - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const ComputerComputer Computer = "computer"` - `Type Computer20241022` - `const Computer20241022Computer20241022 Computer20241022 = "computer_20241022"` - `AllowedCallers []string` - `const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260120 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64` The X11 display number (e.g. 0, 1) for the display. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaMemoryTool20250818 struct{…}` - `Name Memory` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const MemoryMemory Memory = "memory"` - `Type Memory20250818` - `const Memory20250818Memory20250818 Memory20250818 = "memory_20250818"` - `AllowedCallers []string` - `const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260120 BetaMemoryTool20250818AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20250124 struct{…}` - `DisplayHeightPx int64` The height of the display in pixels. - `DisplayWidthPx int64` The width of the display in pixels. - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const ComputerComputer Computer = "computer"` - `Type Computer20250124` - `const Computer20250124Computer20250124 Computer20250124 = "computer_20250124"` - `AllowedCallers []string` - `const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260120 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64` The X11 display number (e.g. 0, 1) for the display. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20241022 struct{…}` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const StrReplaceEditorStrReplaceEditor StrReplaceEditor = "str_replace_editor"` - `Type TextEditor20241022` - `const TextEditor20241022TextEditor20241022 TextEditor20241022 = "text_editor_20241022"` - `AllowedCallers []string` - `const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260120 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20251124 struct{…}` - `DisplayHeightPx int64` The height of the display in pixels. - `DisplayWidthPx int64` The width of the display in pixels. - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const ComputerComputer Computer = "computer"` - `Type Computer20251124` - `const Computer20251124Computer20251124 Computer20251124 = "computer_20251124"` - `AllowedCallers []string` - `const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260120 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64` The X11 display number (e.g. 0, 1) for the display. - `EnableZoom bool` Whether to enable an action to take a zoomed-in screenshot of the screen. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250124 struct{…}` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const StrReplaceEditorStrReplaceEditor StrReplaceEditor = "str_replace_editor"` - `Type TextEditor20250124` - `const TextEditor20250124TextEditor20250124 TextEditor20250124 = "text_editor_20250124"` - `AllowedCallers []string` - `const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260120 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250429 struct{…}` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const StrReplaceBasedEditToolStrReplaceBasedEditTool StrReplaceBasedEditTool = "str_replace_based_edit_tool"` - `Type TextEditor20250429` - `const TextEditor20250429TextEditor20250429 TextEditor20250429 = "text_editor_20250429"` - `AllowedCallers []string` - `const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260120 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250728 struct{…}` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const StrReplaceBasedEditToolStrReplaceBasedEditTool StrReplaceBasedEditTool = "str_replace_based_edit_tool"` - `Type TextEditor20250728` - `const TextEditor20250728TextEditor20250728 TextEditor20250728 = "text_editor_20250728"` - `AllowedCallers []string` - `const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260120 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `MaxCharacters int64` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20250305 struct{…}` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const WebSearchWebSearch WebSearch = "web_search"` - `Type WebSearch20250305` - `const WebSearch20250305WebSearch20250305 WebSearch20250305 = "web_search_20250305"` - `AllowedCallers []string` - `const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260120 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260120"` - `AllowedDomains []string` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `const ApproximateApproximate Approximate = "approximate"` - `City string` The city of the user. - `Country string` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. - `Region string` The region of the user. - `Timezone string` The [IANA timezone](https://nodatime.org/TimeZones) of the user. - `type BetaWebFetchTool20250910 struct{…}` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const WebFetchWebFetch WebFetch = "web_fetch"` - `Type WebFetch20250910` - `const WebFetch20250910WebFetch20250910 WebFetch20250910 = "web_fetch_20250910"` - `AllowedCallers []string` - `const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260120 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260120"` - `AllowedDomains []string` List of domains to allow fetching from - `BlockedDomains []string` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20260209 struct{…}` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const WebSearchWebSearch WebSearch = "web_search"` - `Type WebSearch20260209` - `const WebSearch20260209WebSearch20260209 WebSearch20260209 = "web_search_20260209"` - `AllowedCallers []string` - `const BetaWebSearchTool20260209AllowedCallerDirect BetaWebSearchTool20260209AllowedCaller = "direct"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20250825 BetaWebSearchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260120 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260120"` - `AllowedDomains []string` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260209 struct{…}` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const WebFetchWebFetch WebFetch = "web_fetch"` - `Type WebFetch20260209` - `const WebFetch20260209WebFetch20260209 WebFetch20260209 = "web_fetch_20260209"` - `AllowedCallers []string` - `const BetaWebFetchTool20260209AllowedCallerDirect BetaWebFetchTool20260209AllowedCaller = "direct"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20250825 BetaWebFetchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260120 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260120"` - `AllowedDomains []string` List of domains to allow fetching from - `BlockedDomains []string` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaWebFetchTool20260309 struct{…}` Web fetch tool with use_cache parameter for bypassing cached content. - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const WebFetchWebFetch WebFetch = "web_fetch"` - `Type WebFetch20260309` - `const WebFetch20260309WebFetch20260309 WebFetch20260309 = "web_fetch_20260309"` - `AllowedCallers []string` - `const BetaWebFetchTool20260309AllowedCallerDirect BetaWebFetchTool20260309AllowedCaller = "direct"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20250825 BetaWebFetchTool20260309AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260120 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260120"` - `AllowedDomains []string` List of domains to allow fetching from - `BlockedDomains []string` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `UseCache bool` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaAdvisorTool20260301 struct{…}` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type Model string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `const ModelClaudeOpus4_1 Model = "claude-opus-4-1"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_0 Model = "claude-opus-4-0"` Powerful model for complex tasks - `const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"` Powerful model for complex tasks - `const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"` High-performance model with extended thinking - `const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"` High-performance model with extended thinking - `const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"` Fast and cost-effective model - `string` - `Name Advisor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const AdvisorAdvisor Advisor = "advisor"` - `Type Advisor20260301` - `const Advisor20260301Advisor20260301 Advisor20260301 = "advisor_20260301"` - `AllowedCallers []string` - `const BetaAdvisorTool20260301AllowedCallerDirect BetaAdvisorTool20260301AllowedCaller = "direct"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20250825 BetaAdvisorTool20260301AllowedCaller = "code_execution_20250825"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260120 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Caching BetaCacheControlEphemeral` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolBm25_20251119 struct{…}` - `Name ToolSearchToolBm25` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const ToolSearchToolBm25ToolSearchToolBm25 ToolSearchToolBm25 = "tool_search_tool_bm25"` - `Type BetaToolSearchToolBm25_20251119Type` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"` - `AllowedCallers []string` - `const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolRegex20251119 struct{…}` - `Name ToolSearchToolRegex` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const ToolSearchToolRegexToolSearchToolRegex ToolSearchToolRegex = "tool_search_tool_regex"` - `Type BetaToolSearchToolRegex20251119Type` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"` - `AllowedCallers []string` - `const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaMCPToolset struct{…}` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `MCPServerName string` Name of the MCP server to configure tools for - `Type MCPToolset` - `const MCPToolsetMCPToolset MCPToolset = "mcp_toolset"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Configs map[string, BetaMCPToolConfig]` Configuration overrides for specific tools, keyed by tool name - `DeferLoading bool` - `Enabled bool` - `DefaultConfig BetaMCPToolDefaultConfig` Default configuration applied to all tools from this server - `DeferLoading bool` - `Enabled bool` - `TopK param.Field[int64]` Body param: Only sample from the top K options for each subsequent token. Used to remove "long tail" low probability responses. [Learn more technical details here](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277). Recommended for advanced use cases only. - `TopP param.Field[float64]` Body param: Use nucleus sampling. In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by `top_p`. Recommended for advanced use cases only. - `UserProfileID param.Field[string]` Body param: The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaMessage struct{…}` - `ID string` Unique object identifier. The format and length of IDs may change over time. - `Container BetaContainer` Information about the container used in the request (for the code execution tool) - `ID string` Identifier for the container used in this request - `ExpiresAt Time` The time at which the container will expire. - `Skills []BetaSkill` Skills loaded in the container - `SkillID string` Skill ID - `Type BetaSkillType` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `const BetaSkillTypeAnthropic BetaSkillType = "anthropic"` - `const BetaSkillTypeCustom BetaSkillType = "custom"` - `Version string` Skill version or 'latest' for most recent version - `Content []BetaContentBlockUnion` Content generated by the model. This is an array of content blocks, each of which has a `type` that determines its shape. Example: ```json [{"type": "text", "text": "Hi, I'm Claude."}] ``` If the request input `messages` ended with an `assistant` turn, then the response `content` will continue directly from that last turn. You can use this to constrain the model's output. For example, if the input `messages` were: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("} ] ``` Then the response `content` might be: ```json [{"type": "text", "text": "B)"}] ``` - `type BetaTextBlock struct{…}` - `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`. - `type BetaCitationCharLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationsWebSearchResultLocation struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `Text string` - `Type Text` - `const TextText Text = "text"` - `type BetaThinkingBlock struct{…}` - `Signature string` - `Thinking string` - `Type Thinking` - `const ThinkingThinking Thinking = "thinking"` - `type BetaRedactedThinkingBlock struct{…}` - `Data string` - `Type RedactedThinking` - `const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"` - `type BetaToolUseBlock struct{…}` - `ID string` - `Input map[string, any]` - `Name string` - `Type ToolUse` - `const ToolUseToolUse ToolUse = "tool_use"` - `Caller BetaToolUseBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `Type Direct` - `const DirectDirect Direct = "direct"` - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `ToolID string` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `type BetaServerToolCaller20260120 struct{…}` - `ToolID string` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` - `type BetaServerToolUseBlock struct{…}` - `ID string` - `Input map[string, any]` - `Name BetaServerToolUseBlockName` - `const BetaServerToolUseBlockNameAdvisor BetaServerToolUseBlockName = "advisor"` - `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` - `const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"` - `Caller BetaServerToolUseBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebSearchToolResultBlock struct{…}` - `Content BetaWebSearchToolResultBlockContentUnion` - `type BetaWebSearchToolResultError struct{…}` - `ErrorCode BetaWebSearchToolResultErrorCode` - `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` - `const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"` - `type BetaWebSearchToolResultBlockContentArray []BetaWebSearchResultBlock` - `EncryptedContent string` - `PageAge string` - `Title string` - `Type WebSearchResult` - `const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"` - `URL string` - `ToolUseID string` - `Type WebSearchToolResult` - `const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"` - `Caller BetaWebSearchToolResultBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebFetchToolResultBlock struct{…}` - `Content BetaWebFetchToolResultBlockContentUnion` - `type BetaWebFetchToolResultErrorBlock struct{…}` - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `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` - `const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"` - `type BetaWebFetchBlock struct{…}` - `Content BetaDocumentBlock` - `Citations BetaCitationConfig` Citation configuration for the document - `Enabled bool` - `Source BetaDocumentBlockSourceUnion` - `type BetaBase64PDFSource struct{…}` - `Data string` - `MediaType ApplicationPDF` - `const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaPlainTextSource struct{…}` - `Data string` - `MediaType TextPlain` - `const TextPlainTextPlain TextPlain = "text/plain"` - `Type Text` - `const TextText Text = "text"` - `Title string` The title of the document - `Type Document` - `const DocumentDocument Document = "document"` - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved - `Type WebFetchResult` - `const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"` - `URL string` Fetched content URL - `ToolUseID string` - `Type WebFetchToolResult` - `const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"` - `Caller BetaWebFetchToolResultBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaAdvisorToolResultBlock struct{…}` - `Content BetaAdvisorToolResultBlockContentUnion` - `type BetaAdvisorToolResultError struct{…}` - `ErrorCode BetaAdvisorToolResultErrorErrorCode` - `const BetaAdvisorToolResultErrorErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodePromptTooLong BetaAdvisorToolResultErrorErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorErrorCodeTooManyRequests BetaAdvisorToolResultErrorErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorErrorCodeOverloaded BetaAdvisorToolResultErrorErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorErrorCodeUnavailable BetaAdvisorToolResultErrorErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorErrorCode = "execution_time_exceeded"` - `Type AdvisorToolResultError` - `const AdvisorToolResultErrorAdvisorToolResultError AdvisorToolResultError = "advisor_tool_result_error"` - `type BetaAdvisorResultBlock struct{…}` - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `Text string` - `Type AdvisorResult` - `const AdvisorResultAdvisorResult AdvisorResult = "advisor_result"` - `type BetaAdvisorRedactedResultBlock struct{…}` - `EncryptedContent string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `Type AdvisorRedactedResult` - `const AdvisorRedactedResultAdvisorRedactedResult AdvisorRedactedResult = "advisor_redacted_result"` - `ToolUseID string` - `Type AdvisorToolResult` - `const AdvisorToolResultAdvisorToolResult AdvisorToolResult = "advisor_tool_result"` - `type BetaCodeExecutionToolResultBlock struct{…}` - `Content BetaCodeExecutionToolResultBlockContentUnion` Code execution result with encrypted stdout for PFC + web_search results. - `type BetaCodeExecutionToolResultError struct{…}` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `Type CodeExecutionToolResultError` - `const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"` - `type BetaCodeExecutionResultBlock struct{…}` - `Content []BetaCodeExecutionOutputBlock` - `FileID string` - `Type CodeExecutionOutput` - `const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type CodeExecutionResult` - `const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"` - `type BetaEncryptedCodeExecutionResultBlock struct{…}` Code execution result with encrypted stdout for PFC + web_search results. - `Content []BetaCodeExecutionOutputBlock` - `FileID string` - `Type CodeExecutionOutput` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `Type EncryptedCodeExecutionResult` - `const EncryptedCodeExecutionResultEncryptedCodeExecutionResult EncryptedCodeExecutionResult = "encrypted_code_execution_result"` - `ToolUseID string` - `Type CodeExecutionToolResult` - `const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"` - `type BetaBashCodeExecutionToolResultBlock struct{…}` - `Content BetaBashCodeExecutionToolResultBlockContentUnion` - `type BetaBashCodeExecutionToolResultError struct{…}` - `ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode` - `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` - `const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"` - `type BetaBashCodeExecutionResultBlock struct{…}` - `Content []BetaBashCodeExecutionOutputBlock` - `FileID string` - `Type BashCodeExecutionOutput` - `const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type BashCodeExecutionResult` - `const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"` - `ToolUseID string` - `Type BashCodeExecutionToolResult` - `const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"` - `type BetaTextEditorCodeExecutionToolResultBlock struct{…}` - `Content BetaTextEditorCodeExecutionToolResultBlockContentUnion` - `type BetaTextEditorCodeExecutionToolResultError struct{…}` - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode` - `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` - `const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"` - `type BetaTextEditorCodeExecutionViewResultBlock struct{…}` - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockFileType` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` - `Type TextEditorCodeExecutionViewResult` - `const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"` - `type BetaTextEditorCodeExecutionCreateResultBlock struct{…}` - `IsFileUpdate bool` - `Type TextEditorCodeExecutionCreateResult` - `const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"` - `type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}` - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` - `Type TextEditorCodeExecutionStrReplaceResult` - `const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"` - `ToolUseID string` - `Type TextEditorCodeExecutionToolResult` - `const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"` - `type BetaToolSearchToolResultBlock struct{…}` - `Content BetaToolSearchToolResultBlockContentUnion` - `type BetaToolSearchToolResultError struct{…}` - `ErrorCode BetaToolSearchToolResultErrorErrorCode` - `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` - `const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"` - `type BetaToolSearchToolSearchResultBlock struct{…}` - `ToolReferences []BetaToolReferenceBlock` - `ToolName string` - `Type ToolReference` - `const ToolReferenceToolReference ToolReference = "tool_reference"` - `Type ToolSearchToolSearchResult` - `const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"` - `ToolUseID string` - `Type ToolSearchToolResult` - `const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"` - `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` - `const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"` - `type BetaMCPToolResultBlock struct{…}` - `Content BetaMCPToolResultBlockContentUnion` - `string` - `type BetaMCPToolResultBlockContentBetaMCPToolResultBlockContent []BetaTextBlock` - `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`. - `Text string` - `Type Text` - `IsError bool` - `ToolUseID string` - `Type MCPToolResult` - `const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"` - `type BetaContainerUploadBlock struct{…}` Response model for a file uploaded to the container. - `FileID string` - `Type ContainerUpload` - `const ContainerUploadContainerUpload ContainerUpload = "container_upload"` - `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 - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `Type Compaction` - `const CompactionCompaction Compaction = "compaction"` - `ContextManagement BetaContextManagementResponse` Context management response. Information about context management strategies applied during the request. - `AppliedEdits []BetaContextManagementResponseAppliedEditUnion` List of context management edits that were applied. - `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. - `const ClearToolUses20250919ClearToolUses20250919 ClearToolUses20250919 = "clear_tool_uses_20250919"` - `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. - `const ClearThinking20251015ClearThinking20251015 ClearThinking20251015 = "clear_thinking_20251015"` - `Diagnostics BetaDiagnostics` Response envelope for request-level diagnostics. Present (possibly null) whenever the caller supplied `diagnostics` on the request. - `CacheMissReason BetaDiagnosticsCacheMissReasonUnion` Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - `type BetaCacheMissModelChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type ModelChanged` - `const ModelChangedModelChanged ModelChanged = "model_changed"` - `type BetaCacheMissSystemChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type SystemChanged` - `const SystemChangedSystemChanged SystemChanged = "system_changed"` - `type BetaCacheMissToolsChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type ToolsChanged` - `const ToolsChangedToolsChanged ToolsChanged = "tools_changed"` - `type BetaCacheMissMessagesChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type MessagesChanged` - `const MessagesChangedMessagesChanged MessagesChanged = "messages_changed"` - `type BetaCacheMissPreviousMessageNotFound struct{…}` - `Type PreviousMessageNotFound` - `const PreviousMessageNotFoundPreviousMessageNotFound PreviousMessageNotFound = "previous_message_not_found"` - `type BetaCacheMissUnavailable struct{…}` - `Type Unavailable` - `const UnavailableUnavailable Unavailable = "unavailable"` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type Model string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `const ModelClaudeOpus4_1 Model = "claude-opus-4-1"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_0 Model = "claude-opus-4-0"` Powerful model for complex tasks - `const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"` Powerful model for complex tasks - `const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"` High-performance model with extended thinking - `const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"` High-performance model with extended thinking - `const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"` Fast and cost-effective model - `string` - `Role Assistant` Conversational role of the generated message. This will always be `"assistant"`. - `const AssistantAssistant Assistant = "assistant"` - `StopDetails BetaRefusalStopDetails` Structured information about a refusal. - `Category BetaRefusalStopDetailsCategory` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `const BetaRefusalStopDetailsCategoryCyber BetaRefusalStopDetailsCategory = "cyber"` - `const BetaRefusalStopDetailsCategoryBio BetaRefusalStopDetailsCategory = "bio"` - `Explanation string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `Type Refusal` - `const RefusalRefusal Refusal = "refusal"` - `StopReason BetaStopReason` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `const BetaStopReasonEndTurn BetaStopReason = "end_turn"` - `const BetaStopReasonMaxTokens BetaStopReason = "max_tokens"` - `const BetaStopReasonStopSequence BetaStopReason = "stop_sequence"` - `const BetaStopReasonToolUse BetaStopReason = "tool_use"` - `const BetaStopReasonPauseTurn BetaStopReason = "pause_turn"` - `const BetaStopReasonCompaction BetaStopReason = "compaction"` - `const BetaStopReasonRefusal BetaStopReason = "refusal"` - `const BetaStopReasonModelContextWindowExceeded BetaStopReason = "model_context_window_exceeded"` - `StopSequence string` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `Type Message` Object type. For Messages, this is always `"message"`. - `const MessageMessage Message = "message"` - `Usage BetaUsage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `CacheCreation 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. - `InferenceGeo string` The geographic region where inference was performed for this request. - `InputTokens int64` The number of input tokens which were used. - `Iterations BetaIterationsUsage` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the true context window size from the last iteration - Understand token accumulation across server-side tool use loops - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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 Message` Usage for a sampling iteration - `const MessageMessage Message = "message"` - `type BetaCompactionIterationUsage struct{…}` Token usage for a compaction iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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 - `const CompactionCompaction Compaction = "compaction"` - `type BetaAdvisorMessageIterationUsage struct{…}` Token usage for an advisor sub-inference iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. - `Type AdvisorMessage` Usage for an advisor sub-inference iteration - `const AdvisorMessageAdvisorMessage AdvisorMessage = "advisor_message"` - `OutputTokens int64` The number of output tokens which were used. - `OutputTokensDetails BetaOutputTokensDetails` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `ThinkingTokens int64` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. - `ServerToolUse BetaServerToolUsage` The number of server tool requests. - `WebFetchRequests int64` The number of web fetch tool requests. - `WebSearchRequests int64` The number of web search tool requests. - `ServiceTier BetaUsageServiceTier` If the request used the priority, standard, or batch tier. - `const BetaUsageServiceTierStandard BetaUsageServiceTier = "standard"` - `const BetaUsageServiceTierPriority BetaUsageServiceTier = "priority"` - `const BetaUsageServiceTierBatch BetaUsageServiceTier = "batch"` - `Speed BetaUsageSpeed` The inference speed mode used for this request. - `const BetaUsageSpeedStandard BetaUsageSpeed = "standard"` - `const BetaUsageSpeedFast BetaUsageSpeed = "fast"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaMessage, err := client.Beta.Messages.New(context.TODO(), anthropic.BetaMessageNewParams{ MaxTokens: 1024, Messages: []anthropic.BetaMessageParam{anthropic.BetaMessageParam{ Content: []anthropic.BetaContentBlockParamUnion{anthropic.BetaContentBlockParamUnion{ OfText: &anthropic.BetaTextBlockParam{ Text: "x", }, }}, Role: anthropic.BetaMessageParamRoleUser, }}, Model: anthropic.ModelClaudeOpus4_6, }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaMessage.ID) } ``` #### Response ```json { "id": "msg_013Zva2CMHLNnXjNJJKqJ2EF", "container": { "id": "id", "expires_at": "2019-12-27T18:11:19.117Z", "skills": [ { "skill_id": "pdf", "type": "anthropic", "version": "latest" } ] }, "content": [ { "citations": [ { "cited_text": "cited_text", "document_index": 0, "document_title": "document_title", "end_char_index": 0, "file_id": "file_id", "start_char_index": 0, "type": "char_location" } ], "text": "Hi! My name is Claude.", "type": "text" } ], "context_management": { "applied_edits": [ { "cleared_input_tokens": 0, "cleared_tool_uses": 0, "type": "clear_tool_uses_20250919" } ] }, "diagnostics": { "cache_miss_reason": { "cache_missed_input_tokens": 0, "type": "model_changed" } }, "model": "claude-opus-4-6", "role": "assistant", "stop_details": { "category": "cyber", "explanation": "explanation", "type": "refusal" }, "stop_reason": "end_turn", "stop_sequence": null, "type": "message", "usage": { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_creation_input_tokens": 2051, "cache_read_input_tokens": 2051, "inference_geo": "inference_geo", "input_tokens": 2095, "iterations": [ { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_creation_input_tokens": 0, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0, "type": "message" } ], "output_tokens": 503, "output_tokens_details": { "thinking_tokens": 0 }, "server_tool_use": { "web_fetch_requests": 2, "web_search_requests": 0 }, "service_tier": "standard", "speed": "standard" } } ``` ## Count tokens in a Message `client.Beta.Messages.CountTokens(ctx, params) (*BetaMessageTokensCount, error)` **post** `/v1/messages/count_tokens` Count the number of tokens in a Message. The Token Count API can be used to count the number of tokens in a Message, including tools, images, and documents, without creating it. Learn more about token counting in our [user guide](https://docs.claude.com/en/docs/build-with-claude/token-counting) ### Parameters - `params BetaMessageCountTokensParams` - `Messages param.Field[[]BetaMessageParamResp]` Body param: Input messages. Our models are trained to operate on alternating `user` and `assistant` conversational turns. When creating a new `Message`, you specify the prior conversational turns with the `messages` parameter, and the model then generates the next `Message` in the conversation. Consecutive `user` or `assistant` turns in your request will be combined into a single turn. Each input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages. If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. Example with a single `user` message: ```json [{"role": "user", "content": "Hello, Claude"}] ``` Example with multiple conversational turns: ```json [ {"role": "user", "content": "Hello there."}, {"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"}, {"role": "user", "content": "Can you explain LLMs in plain English?"}, ] ``` Example with a partially-filled response from Claude: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("}, ] ``` Each input message `content` may be either a single `string` or an array of content blocks, where each block has a specific `type`. Using a `string` for `content` is shorthand for an array of one content block of type `"text"`. The following input messages are equivalent: ```json {"role": "user", "content": "Hello, Claude"} ``` ```json {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]} ``` See [input examples](https://docs.claude.com/en/api/messages-examples). Note that if you want to include a [system prompt](https://docs.claude.com/en/docs/system-prompts), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API. There is a limit of 100,000 messages in a single request. - `Content []BetaContentBlockParamUnionResp` - `[]BetaContentBlockParamUnionResp` - `type BetaTextBlockParamResp struct{…}` - `Text string` - `Type Text` - `const TextText Text = "text"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations []BetaTextCitationParamUnionResp` - `type BetaCitationCharLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationWebSearchResultLocationParamResp struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `type BetaImageBlockParamResp struct{…}` - `Source BetaImageBlockParamSourceUnionResp` - `type BetaBase64ImageSource struct{…}` - `Data string` - `MediaType BetaBase64ImageSourceMediaType` - `const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"` - `const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"` - `const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"` - `const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaURLImageSource struct{…}` - `Type URL` - `const URLURL URL = "url"` - `URL string` - `type BetaFileImageSource struct{…}` - `FileID string` - `Type File` - `const FileFile File = "file"` - `Type Image` - `const ImageImage Image = "image"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaRequestDocumentBlock struct{…}` - `Source BetaRequestDocumentBlockSourceUnion` - `type BetaBase64PDFSource struct{…}` - `Data string` - `MediaType ApplicationPDF` - `const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaPlainTextSource struct{…}` - `Data string` - `MediaType TextPlain` - `const TextPlainTextPlain TextPlain = "text/plain"` - `Type Text` - `const TextText Text = "text"` - `type BetaContentBlockSource struct{…}` - `Content BetaContentBlockSourceContentUnion` - `string` - `[]BetaContentBlockSourceContentUnion` - `type BetaTextBlockParamResp struct{…}` - `type BetaImageBlockParamResp struct{…}` - `Type Content` - `const ContentContent Content = "content"` - `type BetaURLPDFSource struct{…}` - `Type URL` - `const URLURL URL = "url"` - `URL string` - `type BetaFileDocumentSource struct{…}` - `FileID string` - `Type File` - `const FileFile File = "file"` - `Type Document` - `const DocumentDocument Document = "document"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` - `Enabled bool` - `Context string` - `Title string` - `type BetaSearchResultBlockParamResp struct{…}` - `Content []BetaTextBlockParamResp` - `Text string` - `Type Text` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnionResp` - `Source string` - `Title string` - `Type SearchResult` - `const SearchResultSearchResult SearchResult = "search_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` - `type BetaThinkingBlockParamResp struct{…}` - `Signature string` - `Thinking string` - `Type Thinking` - `const ThinkingThinking Thinking = "thinking"` - `type BetaRedactedThinkingBlockParamResp struct{…}` - `Data string` - `Type RedactedThinking` - `const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"` - `type BetaToolUseBlockParamResp struct{…}` - `ID string` - `Input map[string, any]` - `Name string` - `Type ToolUse` - `const ToolUseToolUse ToolUse = "tool_use"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Caller BetaToolUseBlockParamCallerUnionResp` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `Type Direct` - `const DirectDirect Direct = "direct"` - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `ToolID string` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `type BetaServerToolCaller20260120 struct{…}` - `ToolID string` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` - `type BetaToolResultBlockParamResp struct{…}` - `ToolUseID string` - `Type ToolResult` - `const ToolResultToolResult ToolResult = "tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Content []BetaToolResultBlockParamContentUnionResp` - `[]BetaToolResultBlockParamContentUnionResp` - `type BetaTextBlockParamResp struct{…}` - `type BetaImageBlockParamResp struct{…}` - `type BetaSearchResultBlockParamResp struct{…}` - `type BetaRequestDocumentBlock struct{…}` - `type BetaToolReferenceBlockParamResp struct{…}` Tool reference block that can be included in tool_result content. - `ToolName string` - `Type ToolReference` - `const ToolReferenceToolReference ToolReference = "tool_reference"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `IsError bool` - `type BetaServerToolUseBlockParamResp struct{…}` - `ID string` - `Input map[string, any]` - `Name BetaServerToolUseBlockParamName` - `const BetaServerToolUseBlockParamNameAdvisor BetaServerToolUseBlockParamName = "advisor"` - `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` - `const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Caller BetaServerToolUseBlockParamCallerUnionResp` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebSearchToolResultBlockParamResp struct{…}` - `Content BetaWebSearchToolResultBlockParamContentUnionResp` - `[]BetaWebSearchResultBlockParamResp` - `EncryptedContent string` - `Title string` - `Type WebSearchResult` - `const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"` - `URL string` - `PageAge string` - `type BetaWebSearchToolRequestError struct{…}` - `ErrorCode BetaWebSearchToolResultErrorCode` - `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` - `const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"` - `ToolUseID string` - `Type WebSearchToolResult` - `const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Caller BetaWebSearchToolResultBlockParamCallerUnionResp` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebFetchToolResultBlockParamResp struct{…}` - `Content BetaWebFetchToolResultBlockParamContentUnionResp` - `type BetaWebFetchToolResultErrorBlockParamResp struct{…}` - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `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` - `const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"` - `type BetaWebFetchBlockParamResp struct{…}` - `Content BetaRequestDocumentBlock` - `Type WebFetchResult` - `const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"` - `URL string` Fetched content URL - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved - `ToolUseID string` - `Type WebFetchToolResult` - `const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Caller BetaWebFetchToolResultBlockParamCallerUnionResp` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaAdvisorToolResultBlockParamResp struct{…}` - `Content BetaAdvisorToolResultBlockParamContentUnionResp` - `type BetaAdvisorToolResultErrorParamResp struct{…}` - `ErrorCode BetaAdvisorToolResultErrorParamErrorCode` - `const BetaAdvisorToolResultErrorParamErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorParamErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorParamErrorCodePromptTooLong BetaAdvisorToolResultErrorParamErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorParamErrorCodeTooManyRequests BetaAdvisorToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorParamErrorCodeOverloaded BetaAdvisorToolResultErrorParamErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorParamErrorCodeUnavailable BetaAdvisorToolResultErrorParamErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorParamErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorParamErrorCode = "execution_time_exceeded"` - `Type AdvisorToolResultError` - `const AdvisorToolResultErrorAdvisorToolResultError AdvisorToolResultError = "advisor_tool_result_error"` - `type BetaAdvisorResultBlockParamResp struct{…}` - `Text string` - `Type AdvisorResult` - `const AdvisorResultAdvisorResult AdvisorResult = "advisor_result"` - `StopReason string` - `type BetaAdvisorRedactedResultBlockParamResp struct{…}` - `EncryptedContent string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `Type AdvisorRedactedResult` - `const AdvisorRedactedResultAdvisorRedactedResult AdvisorRedactedResult = "advisor_redacted_result"` - `StopReason string` - `ToolUseID string` - `Type AdvisorToolResult` - `const AdvisorToolResultAdvisorToolResult AdvisorToolResult = "advisor_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaCodeExecutionToolResultBlockParamResp struct{…}` - `Content BetaCodeExecutionToolResultBlockParamContentUnionResp` Code execution result with encrypted stdout for PFC + web_search results. - `type BetaCodeExecutionToolResultErrorParamResp struct{…}` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `Type CodeExecutionToolResultError` - `const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"` - `type BetaCodeExecutionResultBlockParamResp struct{…}` - `Content []BetaCodeExecutionOutputBlockParamResp` - `FileID string` - `Type CodeExecutionOutput` - `const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type CodeExecutionResult` - `const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"` - `type BetaEncryptedCodeExecutionResultBlockParamResp struct{…}` Code execution result with encrypted stdout for PFC + web_search results. - `Content []BetaCodeExecutionOutputBlockParamResp` - `FileID string` - `Type CodeExecutionOutput` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `Type EncryptedCodeExecutionResult` - `const EncryptedCodeExecutionResultEncryptedCodeExecutionResult EncryptedCodeExecutionResult = "encrypted_code_execution_result"` - `ToolUseID string` - `Type CodeExecutionToolResult` - `const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaBashCodeExecutionToolResultBlockParamResp struct{…}` - `Content BetaBashCodeExecutionToolResultBlockParamContentUnionResp` - `type BetaBashCodeExecutionToolResultErrorParamResp struct{…}` - `ErrorCode BetaBashCodeExecutionToolResultErrorParamErrorCode` - `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` - `const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"` - `type BetaBashCodeExecutionResultBlockParamResp struct{…}` - `Content []BetaBashCodeExecutionOutputBlockParamResp` - `FileID string` - `Type BashCodeExecutionOutput` - `const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type BashCodeExecutionResult` - `const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"` - `ToolUseID string` - `Type BashCodeExecutionToolResult` - `const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaTextEditorCodeExecutionToolResultBlockParamResp struct{…}` - `Content BetaTextEditorCodeExecutionToolResultBlockParamContentUnionResp` - `type BetaTextEditorCodeExecutionToolResultErrorParamResp struct{…}` - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorParamErrorCode` - `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` - `const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"` - `ErrorMessage string` - `type BetaTextEditorCodeExecutionViewResultBlockParamResp struct{…}` - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockParamFileType` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeText BetaTextEditorCodeExecutionViewResultBlockParamFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeImage BetaTextEditorCodeExecutionViewResultBlockParamFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypePDF BetaTextEditorCodeExecutionViewResultBlockParamFileType = "pdf"` - `Type TextEditorCodeExecutionViewResult` - `const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` - `type BetaTextEditorCodeExecutionCreateResultBlockParamResp struct{…}` - `IsFileUpdate bool` - `Type TextEditorCodeExecutionCreateResult` - `const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"` - `type BetaTextEditorCodeExecutionStrReplaceResultBlockParamResp struct{…}` - `Type TextEditorCodeExecutionStrReplaceResult` - `const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"` - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` - `ToolUseID string` - `Type TextEditorCodeExecutionToolResult` - `const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaToolSearchToolResultBlockParamResp struct{…}` - `Content BetaToolSearchToolResultBlockParamContentUnionResp` - `type BetaToolSearchToolResultErrorParamResp struct{…}` - `ErrorCode BetaToolSearchToolResultErrorParamErrorCode` - `const BetaToolSearchToolResultErrorParamErrorCodeInvalidToolInput BetaToolSearchToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaToolSearchToolResultErrorParamErrorCodeUnavailable BetaToolSearchToolResultErrorParamErrorCode = "unavailable"` - `const BetaToolSearchToolResultErrorParamErrorCodeTooManyRequests BetaToolSearchToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaToolSearchToolResultErrorParamErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorParamErrorCode = "execution_time_exceeded"` - `Type ToolSearchToolResultError` - `const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"` - `type BetaToolSearchToolSearchResultBlockParamResp struct{…}` - `ToolReferences []BetaToolReferenceBlockParamResp` - `ToolName string` - `Type ToolReference` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type ToolSearchToolSearchResult` - `const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"` - `ToolUseID string` - `Type ToolSearchToolResult` - `const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaMCPToolUseBlockParamResp struct{…}` - `ID string` - `Input map[string, any]` - `Name string` - `ServerName string` The name of the MCP server - `Type MCPToolUse` - `const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaRequestMCPToolResultBlockParamResp struct{…}` - `ToolUseID string` - `Type MCPToolResult` - `const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Content BetaRequestMCPToolResultBlockParamContentUnionResp` - `string` - `[]BetaTextBlockParamResp` - `Text string` - `Type Text` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnionResp` - `IsError bool` - `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` - `const ContainerUploadContainerUpload ContainerUpload = "container_upload"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `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. - `Type Compaction` - `const CompactionCompaction Compaction = "compaction"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Content string` Summary of previously compacted content, or null if compaction failed - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `type BetaMidConversationSystemBlockParamResp struct{…}` System instructions that appear mid-conversation. Use this block to provide or update system-level instructions at a specific point in the conversation, rather than only via the top-level `system` parameter. - `Content []BetaTextBlockParamResp` System instruction text blocks. - `Text string` - `Type Text` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnionResp` - `Type MidConvSystem` - `const MidConvSystemMidConvSystem MidConvSystem = "mid_conv_system"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Role BetaMessageParamRole` - `const BetaMessageParamRoleUser BetaMessageParamRole = "user"` - `const BetaMessageParamRoleAssistant BetaMessageParamRole = "assistant"` - `const BetaMessageParamRoleSystem BetaMessageParamRole = "system"` - `Model param.Field[Model]` Body param: The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `CacheControl param.Field[BetaCacheControlEphemeral]` Body param: Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request. - `ContextManagement param.Field[BetaContextManagementConfig]` Body param: Context management configuration. This allows you to control how Claude manages context across multiple requests, such as whether to clear function results or not. - `MCPServers param.Field[[]BetaRequestMCPServerURLDefinition]` Body param: MCP servers to be utilized in this request - `Name string` - `Type URL` - `const URLURL URL = "url"` - `URL string` - `AuthorizationToken string` - `ToolConfiguration BetaRequestMCPServerToolConfiguration` - `AllowedTools []string` - `Enabled bool` - `OutputConfig param.Field[BetaOutputConfig]` Body param: Configuration options for the model's output, such as the output format. - `OutputFormat param.Field[BetaJSONOutputFormat]` Body param: Deprecated: Use `output_config.format` instead. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) A schema to specify Claude's output format in responses. This parameter will be removed in a future release. - `Speed param.Field[BetaMessageCountTokensParamsSpeed]` Body param: The inference speed mode for this request. `"fast"` enables high output-tokens-per-second inference. - `const BetaMessageCountTokensParamsSpeedStandard BetaMessageCountTokensParamsSpeed = "standard"` - `const BetaMessageCountTokensParamsSpeedFast BetaMessageCountTokensParamsSpeed = "fast"` - `System param.Field[BetaMessageCountTokensParamsSystemUnion]` Body param: System prompt. A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://docs.claude.com/en/docs/system-prompts). - `string` - `type BetaMessageCountTokensParamsSystemArray []BetaTextBlockParamResp` - `Text string` - `Type Text` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnionResp` - `Thinking param.Field[BetaThinkingConfigParamUnionResp]` Body param: Configuration for enabling Claude's extended thinking. When enabled, responses include `thinking` content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your `max_tokens` limit. See [extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details. - `ToolChoice param.Field[BetaToolChoiceUnion]` Body param: How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. - `Tools param.Field[[]BetaMessageCountTokensParamsToolUnion]` Body param: Definitions of tools that the model may use. If you include `tools` in your API request, the model may return `tool_use` content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using `tool_result` content blocks. There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://docs.claude.com/en/docs/agents-and-tools/tool-use/overview#server-tools), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://docs.claude.com/en/docs/agents-and-tools/tool-use/web-search-tool)). Each tool definition includes: * `name`: Name of the tool. * `description`: Optional, but strongly-recommended description of the tool. * `input_schema`: [JSON schema](https://json-schema.org/draft/2020-12) for the tool `input` shape that the model will produce in `tool_use` output content blocks. For example, if you defined `tools` as: ```json [ { "name": "get_stock_price", "description": "Get the current stock price for a given ticker symbol.", "input_schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "The stock ticker symbol, e.g. AAPL for Apple Inc." } }, "required": ["ticker"] } } ] ``` And then asked the model "What's the S&P 500 at today?", the model might produce `tool_use` content blocks in the response like this: ```json [ { "type": "tool_use", "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "name": "get_stock_price", "input": { "ticker": "^GSPC" } } ] ``` You might then run your `get_stock_price` tool with `{"ticker": "^GSPC"}` as an input, and return the following back to the model in a subsequent `user` message: ```json [ { "type": "tool_result", "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "content": "259.75 USD" } ] ``` Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output. See our [guide](https://docs.claude.com/en/docs/tool-use) for more details. - `type BetaTool struct{…}` - `InputSchema BetaToolInputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `const ObjectObject Object = "object"` - `Properties map[string, any]` - `Required []string` - `Name string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string` - `const BetaToolAllowedCallerDirect BetaToolAllowedCaller = "direct"` - `const BetaToolAllowedCallerCodeExecution20250825 BetaToolAllowedCaller = "code_execution_20250825"` - `const BetaToolAllowedCallerCodeExecution20260120 BetaToolAllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Description string` Description of what this tool does. Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema. - `EagerInputStreaming bool` Enable eager input streaming for this tool. When true, tool input parameters will be streamed incrementally as they are generated, and types will be inferred on-the-fly rather than buffering the full JSON output. When false, streaming is disabled for this tool even if the fine-grained-tool-streaming beta is active. When null (default), uses the default behavior based on beta headers. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `Type BetaToolType` - `const BetaToolTypeCustom BetaToolType = "custom"` - `type BetaToolBash20241022 struct{…}` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const BashBash Bash = "bash"` - `Type Bash20241022` - `const Bash20241022Bash20241022 Bash20241022 = "bash_20241022"` - `AllowedCallers []string` - `const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"` - `const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260120 BetaToolBash20241022AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20250124 struct{…}` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const BashBash Bash = "bash"` - `Type Bash20250124` - `const Bash20250124Bash20250124 Bash20250124 = "bash_20250124"` - `AllowedCallers []string` - `const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"` - `const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260120 BetaToolBash20250124AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250522 struct{…}` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const CodeExecutionCodeExecution CodeExecution = "code_execution"` - `Type CodeExecution20250522` - `const CodeExecution20250522CodeExecution20250522 CodeExecution20250522 = "code_execution_20250522"` - `AllowedCallers []string` - `const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250825 struct{…}` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const CodeExecutionCodeExecution CodeExecution = "code_execution"` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `AllowedCallers []string` - `const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260120 struct{…}` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const CodeExecutionCodeExecution CodeExecution = "code_execution"` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` - `AllowedCallers []string` - `const BetaCodeExecutionTool20260120AllowedCallerDirect BetaCodeExecutionTool20260120AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20241022 struct{…}` - `DisplayHeightPx int64` The height of the display in pixels. - `DisplayWidthPx int64` The width of the display in pixels. - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const ComputerComputer Computer = "computer"` - `Type Computer20241022` - `const Computer20241022Computer20241022 Computer20241022 = "computer_20241022"` - `AllowedCallers []string` - `const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260120 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64` The X11 display number (e.g. 0, 1) for the display. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaMemoryTool20250818 struct{…}` - `Name Memory` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const MemoryMemory Memory = "memory"` - `Type Memory20250818` - `const Memory20250818Memory20250818 Memory20250818 = "memory_20250818"` - `AllowedCallers []string` - `const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260120 BetaMemoryTool20250818AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20250124 struct{…}` - `DisplayHeightPx int64` The height of the display in pixels. - `DisplayWidthPx int64` The width of the display in pixels. - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const ComputerComputer Computer = "computer"` - `Type Computer20250124` - `const Computer20250124Computer20250124 Computer20250124 = "computer_20250124"` - `AllowedCallers []string` - `const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260120 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64` The X11 display number (e.g. 0, 1) for the display. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20241022 struct{…}` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const StrReplaceEditorStrReplaceEditor StrReplaceEditor = "str_replace_editor"` - `Type TextEditor20241022` - `const TextEditor20241022TextEditor20241022 TextEditor20241022 = "text_editor_20241022"` - `AllowedCallers []string` - `const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260120 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20251124 struct{…}` - `DisplayHeightPx int64` The height of the display in pixels. - `DisplayWidthPx int64` The width of the display in pixels. - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const ComputerComputer Computer = "computer"` - `Type Computer20251124` - `const Computer20251124Computer20251124 Computer20251124 = "computer_20251124"` - `AllowedCallers []string` - `const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260120 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64` The X11 display number (e.g. 0, 1) for the display. - `EnableZoom bool` Whether to enable an action to take a zoomed-in screenshot of the screen. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250124 struct{…}` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const StrReplaceEditorStrReplaceEditor StrReplaceEditor = "str_replace_editor"` - `Type TextEditor20250124` - `const TextEditor20250124TextEditor20250124 TextEditor20250124 = "text_editor_20250124"` - `AllowedCallers []string` - `const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260120 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250429 struct{…}` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const StrReplaceBasedEditToolStrReplaceBasedEditTool StrReplaceBasedEditTool = "str_replace_based_edit_tool"` - `Type TextEditor20250429` - `const TextEditor20250429TextEditor20250429 TextEditor20250429 = "text_editor_20250429"` - `AllowedCallers []string` - `const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260120 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250728 struct{…}` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const StrReplaceBasedEditToolStrReplaceBasedEditTool StrReplaceBasedEditTool = "str_replace_based_edit_tool"` - `Type TextEditor20250728` - `const TextEditor20250728TextEditor20250728 TextEditor20250728 = "text_editor_20250728"` - `AllowedCallers []string` - `const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260120 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `MaxCharacters int64` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20250305 struct{…}` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const WebSearchWebSearch WebSearch = "web_search"` - `Type WebSearch20250305` - `const WebSearch20250305WebSearch20250305 WebSearch20250305 = "web_search_20250305"` - `AllowedCallers []string` - `const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260120 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260120"` - `AllowedDomains []string` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `const ApproximateApproximate Approximate = "approximate"` - `City string` The city of the user. - `Country string` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. - `Region string` The region of the user. - `Timezone string` The [IANA timezone](https://nodatime.org/TimeZones) of the user. - `type BetaWebFetchTool20250910 struct{…}` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const WebFetchWebFetch WebFetch = "web_fetch"` - `Type WebFetch20250910` - `const WebFetch20250910WebFetch20250910 WebFetch20250910 = "web_fetch_20250910"` - `AllowedCallers []string` - `const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260120 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260120"` - `AllowedDomains []string` List of domains to allow fetching from - `BlockedDomains []string` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20260209 struct{…}` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const WebSearchWebSearch WebSearch = "web_search"` - `Type WebSearch20260209` - `const WebSearch20260209WebSearch20260209 WebSearch20260209 = "web_search_20260209"` - `AllowedCallers []string` - `const BetaWebSearchTool20260209AllowedCallerDirect BetaWebSearchTool20260209AllowedCaller = "direct"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20250825 BetaWebSearchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260120 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260120"` - `AllowedDomains []string` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260209 struct{…}` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const WebFetchWebFetch WebFetch = "web_fetch"` - `Type WebFetch20260209` - `const WebFetch20260209WebFetch20260209 WebFetch20260209 = "web_fetch_20260209"` - `AllowedCallers []string` - `const BetaWebFetchTool20260209AllowedCallerDirect BetaWebFetchTool20260209AllowedCaller = "direct"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20250825 BetaWebFetchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260120 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260120"` - `AllowedDomains []string` List of domains to allow fetching from - `BlockedDomains []string` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaWebFetchTool20260309 struct{…}` Web fetch tool with use_cache parameter for bypassing cached content. - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const WebFetchWebFetch WebFetch = "web_fetch"` - `Type WebFetch20260309` - `const WebFetch20260309WebFetch20260309 WebFetch20260309 = "web_fetch_20260309"` - `AllowedCallers []string` - `const BetaWebFetchTool20260309AllowedCallerDirect BetaWebFetchTool20260309AllowedCaller = "direct"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20250825 BetaWebFetchTool20260309AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260120 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260120"` - `AllowedDomains []string` List of domains to allow fetching from - `BlockedDomains []string` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `UseCache bool` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaAdvisorTool20260301 struct{…}` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type Model string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `const ModelClaudeOpus4_1 Model = "claude-opus-4-1"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_0 Model = "claude-opus-4-0"` Powerful model for complex tasks - `const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"` Powerful model for complex tasks - `const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"` High-performance model with extended thinking - `const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"` High-performance model with extended thinking - `const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"` Fast and cost-effective model - `string` - `Name Advisor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const AdvisorAdvisor Advisor = "advisor"` - `Type Advisor20260301` - `const Advisor20260301Advisor20260301 Advisor20260301 = "advisor_20260301"` - `AllowedCallers []string` - `const BetaAdvisorTool20260301AllowedCallerDirect BetaAdvisorTool20260301AllowedCaller = "direct"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20250825 BetaAdvisorTool20260301AllowedCaller = "code_execution_20250825"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260120 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Caching BetaCacheControlEphemeral` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolBm25_20251119 struct{…}` - `Name ToolSearchToolBm25` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const ToolSearchToolBm25ToolSearchToolBm25 ToolSearchToolBm25 = "tool_search_tool_bm25"` - `Type BetaToolSearchToolBm25_20251119Type` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"` - `AllowedCallers []string` - `const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolRegex20251119 struct{…}` - `Name ToolSearchToolRegex` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const ToolSearchToolRegexToolSearchToolRegex ToolSearchToolRegex = "tool_search_tool_regex"` - `Type BetaToolSearchToolRegex20251119Type` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"` - `AllowedCallers []string` - `const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaMCPToolset struct{…}` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `MCPServerName string` Name of the MCP server to configure tools for - `Type MCPToolset` - `const MCPToolsetMCPToolset MCPToolset = "mcp_toolset"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Configs map[string, BetaMCPToolConfig]` Configuration overrides for specific tools, keyed by tool name - `DeferLoading bool` - `Enabled bool` - `DefaultConfig BetaMCPToolDefaultConfig` Default configuration applied to all tools from this server - `DeferLoading bool` - `Enabled bool` - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaMessageTokensCount struct{…}` - `ContextManagement BetaCountTokensContextManagementResponse` Information about context management applied to the message. - `OriginalInputTokens int64` The original token count before context management was applied - `InputTokens int64` The total number of tokens across the provided list of messages, system prompt, and tools. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaMessageTokensCount, err := client.Beta.Messages.CountTokens(context.TODO(), anthropic.BetaMessageCountTokensParams{ Messages: []anthropic.BetaMessageParam{anthropic.BetaMessageParam{ Content: []anthropic.BetaContentBlockParamUnion{anthropic.BetaContentBlockParamUnion{ OfText: &anthropic.BetaTextBlockParam{ Text: "x", }, }}, Role: anthropic.BetaMessageParamRoleUser, }}, Model: anthropic.ModelClaudeOpus4_6, }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaMessageTokensCount.ContextManagement) } ``` #### Response ```json { "context_management": { "original_input_tokens": 0 }, "input_tokens": 2095 } ``` ## Domain Types ### Beta Advisor Message Iteration Usage - `type BetaAdvisorMessageIterationUsage struct{…}` Token usage for an advisor sub-inference iteration. - `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. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type Model string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `const ModelClaudeOpus4_1 Model = "claude-opus-4-1"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_0 Model = "claude-opus-4-0"` Powerful model for complex tasks - `const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"` Powerful model for complex tasks - `const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"` High-performance model with extended thinking - `const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"` High-performance model with extended thinking - `const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"` Fast and cost-effective model - `string` - `OutputTokens int64` The number of output tokens which were used. - `Type AdvisorMessage` Usage for an advisor sub-inference iteration - `const AdvisorMessageAdvisorMessage AdvisorMessage = "advisor_message"` ### Beta Advisor Redacted Result Block - `type BetaAdvisorRedactedResultBlock struct{…}` - `EncryptedContent string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `Type AdvisorRedactedResult` - `const AdvisorRedactedResultAdvisorRedactedResult AdvisorRedactedResult = "advisor_redacted_result"` ### Beta Advisor Redacted Result Block Param - `type BetaAdvisorRedactedResultBlockParamResp struct{…}` - `EncryptedContent string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `Type AdvisorRedactedResult` - `const AdvisorRedactedResultAdvisorRedactedResult AdvisorRedactedResult = "advisor_redacted_result"` - `StopReason string` ### Beta Advisor Result Block - `type BetaAdvisorResultBlock struct{…}` - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `Text string` - `Type AdvisorResult` - `const AdvisorResultAdvisorResult AdvisorResult = "advisor_result"` ### Beta Advisor Result Block Param - `type BetaAdvisorResultBlockParamResp struct{…}` - `Text string` - `Type AdvisorResult` - `const AdvisorResultAdvisorResult AdvisorResult = "advisor_result"` - `StopReason string` ### Beta Advisor Tool 20260301 - `type BetaAdvisorTool20260301 struct{…}` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type Model string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `const ModelClaudeOpus4_1 Model = "claude-opus-4-1"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_0 Model = "claude-opus-4-0"` Powerful model for complex tasks - `const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"` Powerful model for complex tasks - `const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"` High-performance model with extended thinking - `const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"` High-performance model with extended thinking - `const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"` Fast and cost-effective model - `string` - `Name Advisor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const AdvisorAdvisor Advisor = "advisor"` - `Type Advisor20260301` - `const Advisor20260301Advisor20260301 Advisor20260301 = "advisor_20260301"` - `AllowedCallers []string` - `const BetaAdvisorTool20260301AllowedCallerDirect BetaAdvisorTool20260301AllowedCaller = "direct"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20250825 BetaAdvisorTool20260301AllowedCaller = "code_execution_20250825"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260120 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Caching BetaCacheControlEphemeral` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs ### Beta Advisor Tool Result Block - `type BetaAdvisorToolResultBlock struct{…}` - `Content BetaAdvisorToolResultBlockContentUnion` - `type BetaAdvisorToolResultError struct{…}` - `ErrorCode BetaAdvisorToolResultErrorErrorCode` - `const BetaAdvisorToolResultErrorErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodePromptTooLong BetaAdvisorToolResultErrorErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorErrorCodeTooManyRequests BetaAdvisorToolResultErrorErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorErrorCodeOverloaded BetaAdvisorToolResultErrorErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorErrorCodeUnavailable BetaAdvisorToolResultErrorErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorErrorCode = "execution_time_exceeded"` - `Type AdvisorToolResultError` - `const AdvisorToolResultErrorAdvisorToolResultError AdvisorToolResultError = "advisor_tool_result_error"` - `type BetaAdvisorResultBlock struct{…}` - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `Text string` - `Type AdvisorResult` - `const AdvisorResultAdvisorResult AdvisorResult = "advisor_result"` - `type BetaAdvisorRedactedResultBlock struct{…}` - `EncryptedContent string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `Type AdvisorRedactedResult` - `const AdvisorRedactedResultAdvisorRedactedResult AdvisorRedactedResult = "advisor_redacted_result"` - `ToolUseID string` - `Type AdvisorToolResult` - `const AdvisorToolResultAdvisorToolResult AdvisorToolResult = "advisor_tool_result"` ### Beta Advisor Tool Result Block Param - `type BetaAdvisorToolResultBlockParamResp struct{…}` - `Content BetaAdvisorToolResultBlockParamContentUnionResp` - `type BetaAdvisorToolResultErrorParamResp struct{…}` - `ErrorCode BetaAdvisorToolResultErrorParamErrorCode` - `const BetaAdvisorToolResultErrorParamErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorParamErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorParamErrorCodePromptTooLong BetaAdvisorToolResultErrorParamErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorParamErrorCodeTooManyRequests BetaAdvisorToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorParamErrorCodeOverloaded BetaAdvisorToolResultErrorParamErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorParamErrorCodeUnavailable BetaAdvisorToolResultErrorParamErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorParamErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorParamErrorCode = "execution_time_exceeded"` - `Type AdvisorToolResultError` - `const AdvisorToolResultErrorAdvisorToolResultError AdvisorToolResultError = "advisor_tool_result_error"` - `type BetaAdvisorResultBlockParamResp struct{…}` - `Text string` - `Type AdvisorResult` - `const AdvisorResultAdvisorResult AdvisorResult = "advisor_result"` - `StopReason string` - `type BetaAdvisorRedactedResultBlockParamResp struct{…}` - `EncryptedContent string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `Type AdvisorRedactedResult` - `const AdvisorRedactedResultAdvisorRedactedResult AdvisorRedactedResult = "advisor_redacted_result"` - `StopReason string` - `ToolUseID string` - `Type AdvisorToolResult` - `const AdvisorToolResultAdvisorToolResult AdvisorToolResult = "advisor_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` ### Beta Advisor Tool Result Error - `type BetaAdvisorToolResultError struct{…}` - `ErrorCode BetaAdvisorToolResultErrorErrorCode` - `const BetaAdvisorToolResultErrorErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodePromptTooLong BetaAdvisorToolResultErrorErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorErrorCodeTooManyRequests BetaAdvisorToolResultErrorErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorErrorCodeOverloaded BetaAdvisorToolResultErrorErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorErrorCodeUnavailable BetaAdvisorToolResultErrorErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorErrorCode = "execution_time_exceeded"` - `Type AdvisorToolResultError` - `const AdvisorToolResultErrorAdvisorToolResultError AdvisorToolResultError = "advisor_tool_result_error"` ### Beta Advisor Tool Result Error Param - `type BetaAdvisorToolResultErrorParamResp struct{…}` - `ErrorCode BetaAdvisorToolResultErrorParamErrorCode` - `const BetaAdvisorToolResultErrorParamErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorParamErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorParamErrorCodePromptTooLong BetaAdvisorToolResultErrorParamErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorParamErrorCodeTooManyRequests BetaAdvisorToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorParamErrorCodeOverloaded BetaAdvisorToolResultErrorParamErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorParamErrorCodeUnavailable BetaAdvisorToolResultErrorParamErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorParamErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorParamErrorCode = "execution_time_exceeded"` - `Type AdvisorToolResultError` - `const AdvisorToolResultErrorAdvisorToolResultError AdvisorToolResultError = "advisor_tool_result_error"` ### Beta All Thinking Turns - `type BetaAllThinkingTurns struct{…}` - `Type All` - `const AllAll All = "all"` ### Beta Base64 Image Source - `type BetaBase64ImageSource struct{…}` - `Data string` - `MediaType BetaBase64ImageSourceMediaType` - `const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"` - `const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"` - `const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"` - `const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` ### Beta Base64 PDF Source - `type BetaBase64PDFSource struct{…}` - `Data string` - `MediaType ApplicationPDF` - `const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` ### Beta Bash Code Execution Output Block - `type BetaBashCodeExecutionOutputBlock struct{…}` - `FileID string` - `Type BashCodeExecutionOutput` - `const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"` ### Beta Bash Code Execution Output Block Param - `type BetaBashCodeExecutionOutputBlockParamResp struct{…}` - `FileID string` - `Type BashCodeExecutionOutput` - `const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"` ### Beta Bash Code Execution Result Block - `type BetaBashCodeExecutionResultBlock struct{…}` - `Content []BetaBashCodeExecutionOutputBlock` - `FileID string` - `Type BashCodeExecutionOutput` - `const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type BashCodeExecutionResult` - `const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"` ### Beta Bash Code Execution Result Block Param - `type BetaBashCodeExecutionResultBlockParamResp struct{…}` - `Content []BetaBashCodeExecutionOutputBlockParamResp` - `FileID string` - `Type BashCodeExecutionOutput` - `const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type BashCodeExecutionResult` - `const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"` ### Beta Bash Code Execution Tool Result Block - `type BetaBashCodeExecutionToolResultBlock struct{…}` - `Content BetaBashCodeExecutionToolResultBlockContentUnion` - `type BetaBashCodeExecutionToolResultError struct{…}` - `ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode` - `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` - `const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"` - `type BetaBashCodeExecutionResultBlock struct{…}` - `Content []BetaBashCodeExecutionOutputBlock` - `FileID string` - `Type BashCodeExecutionOutput` - `const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type BashCodeExecutionResult` - `const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"` - `ToolUseID string` - `Type BashCodeExecutionToolResult` - `const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"` ### Beta Bash Code Execution Tool Result Block Param - `type BetaBashCodeExecutionToolResultBlockParamResp struct{…}` - `Content BetaBashCodeExecutionToolResultBlockParamContentUnionResp` - `type BetaBashCodeExecutionToolResultErrorParamResp struct{…}` - `ErrorCode BetaBashCodeExecutionToolResultErrorParamErrorCode` - `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` - `const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"` - `type BetaBashCodeExecutionResultBlockParamResp struct{…}` - `Content []BetaBashCodeExecutionOutputBlockParamResp` - `FileID string` - `Type BashCodeExecutionOutput` - `const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type BashCodeExecutionResult` - `const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"` - `ToolUseID string` - `Type BashCodeExecutionToolResult` - `const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` ### Beta Bash Code Execution Tool Result Error - `type BetaBashCodeExecutionToolResultError struct{…}` - `ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode` - `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` - `const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"` ### Beta Bash Code Execution Tool Result Error Param - `type BetaBashCodeExecutionToolResultErrorParamResp struct{…}` - `ErrorCode BetaBashCodeExecutionToolResultErrorParamErrorCode` - `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` - `const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"` ### Beta Cache Control Ephemeral - `type BetaCacheControlEphemeral struct{…}` - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` ### Beta Cache Creation - `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. ### Beta Cache Miss Messages Changed - `type BetaCacheMissMessagesChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type MessagesChanged` - `const MessagesChangedMessagesChanged MessagesChanged = "messages_changed"` ### Beta Cache Miss Model Changed - `type BetaCacheMissModelChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type ModelChanged` - `const ModelChangedModelChanged ModelChanged = "model_changed"` ### Beta Cache Miss Previous Message Not Found - `type BetaCacheMissPreviousMessageNotFound struct{…}` - `Type PreviousMessageNotFound` - `const PreviousMessageNotFoundPreviousMessageNotFound PreviousMessageNotFound = "previous_message_not_found"` ### Beta Cache Miss System Changed - `type BetaCacheMissSystemChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type SystemChanged` - `const SystemChangedSystemChanged SystemChanged = "system_changed"` ### Beta Cache Miss Tools Changed - `type BetaCacheMissToolsChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type ToolsChanged` - `const ToolsChangedToolsChanged ToolsChanged = "tools_changed"` ### Beta Cache Miss Unavailable - `type BetaCacheMissUnavailable struct{…}` - `Type Unavailable` - `const UnavailableUnavailable Unavailable = "unavailable"` ### Beta Citation Char Location - `type BetaCitationCharLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` ### Beta Citation Char Location Param - `type BetaCitationCharLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` ### Beta Citation Config - `type BetaCitationConfig struct{…}` - `Enabled bool` ### Beta Citation Content Block Location - `type BetaCitationContentBlockLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` ### Beta Citation Content Block Location Param - `type BetaCitationContentBlockLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` ### Beta Citation Page Location - `type BetaCitationPageLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` ### Beta Citation Page Location Param - `type BetaCitationPageLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` ### Beta Citation Search Result Location - `type BetaCitationSearchResultLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` ### Beta Citation Search Result Location Param - `type BetaCitationSearchResultLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` ### Beta Citation Web Search Result Location Param - `type BetaCitationWebSearchResultLocationParamResp struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` ### Beta Citations Config Param - `type BetaCitationsConfigParamResp struct{…}` - `Enabled bool` ### Beta Citations Delta - `type BetaCitationsDelta struct{…}` - `Citation BetaCitationsDeltaCitationUnion` - `type BetaCitationCharLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationsWebSearchResultLocation struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `Type CitationsDelta` - `const CitationsDeltaCitationsDelta CitationsDelta = "citations_delta"` ### Beta Citations Web Search Result Location - `type BetaCitationsWebSearchResultLocation struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` ### Beta Clear Thinking 20251015 Edit - `type BetaClearThinking20251015Edit struct{…}` - `Type ClearThinking20251015` - `const ClearThinking20251015ClearThinking20251015 ClearThinking20251015 = "clear_thinking_20251015"` - `Keep BetaClearThinking20251015EditKeepUnion` Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed. - `type BetaThinkingTurns struct{…}` - `Type ThinkingTurns` - `const ThinkingTurnsThinkingTurns ThinkingTurns = "thinking_turns"` - `Value int64` - `type BetaAllThinkingTurns struct{…}` - `Type All` - `const AllAll All = "all"` - `All` - `const AllAll All = "all"` ### Beta Clear Thinking 20251015 Edit Response - `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. - `const ClearThinking20251015ClearThinking20251015 ClearThinking20251015 = "clear_thinking_20251015"` ### Beta Clear Tool Uses 20250919 Edit - `type BetaClearToolUses20250919Edit struct{…}` - `Type ClearToolUses20250919` - `const ClearToolUses20250919ClearToolUses20250919 ClearToolUses20250919 = "clear_tool_uses_20250919"` - `ClearAtLeast BetaInputTokensClearAtLeast` Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed. - `Type InputTokens` - `const InputTokensInputTokens InputTokens = "input_tokens"` - `Value int64` - `ClearToolInputs BetaClearToolUses20250919EditClearToolInputsUnion` Whether to clear all tool inputs (bool) or specific tool inputs to clear (list) - `bool` - `[]string` - `ExcludeTools []string` Tool names whose uses are preserved from clearing - `Keep BetaToolUsesKeep` Number of tool uses to retain in the conversation - `Type ToolUses` - `const ToolUsesToolUses ToolUses = "tool_uses"` - `Value int64` - `Trigger BetaClearToolUses20250919EditTriggerUnion` Condition that triggers the context management strategy - `type BetaInputTokensTrigger struct{…}` - `Type InputTokens` - `const InputTokensInputTokens InputTokens = "input_tokens"` - `Value int64` - `type BetaToolUsesTrigger struct{…}` - `Type ToolUses` - `const ToolUsesToolUses ToolUses = "tool_uses"` - `Value int64` ### Beta Clear Tool Uses 20250919 Edit Response - `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. - `const ClearToolUses20250919ClearToolUses20250919 ClearToolUses20250919 = "clear_tool_uses_20250919"` ### Beta Code Execution Output Block - `type BetaCodeExecutionOutputBlock struct{…}` - `FileID string` - `Type CodeExecutionOutput` - `const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"` ### Beta Code Execution Output Block Param - `type BetaCodeExecutionOutputBlockParamResp struct{…}` - `FileID string` - `Type CodeExecutionOutput` - `const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"` ### Beta Code Execution Result Block - `type BetaCodeExecutionResultBlock struct{…}` - `Content []BetaCodeExecutionOutputBlock` - `FileID string` - `Type CodeExecutionOutput` - `const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type CodeExecutionResult` - `const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"` ### Beta Code Execution Result Block Param - `type BetaCodeExecutionResultBlockParamResp struct{…}` - `Content []BetaCodeExecutionOutputBlockParamResp` - `FileID string` - `Type CodeExecutionOutput` - `const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type CodeExecutionResult` - `const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"` ### Beta Code Execution Tool 20250522 - `type BetaCodeExecutionTool20250522 struct{…}` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const CodeExecutionCodeExecution CodeExecution = "code_execution"` - `Type CodeExecution20250522` - `const CodeExecution20250522CodeExecution20250522 CodeExecution20250522 = "code_execution_20250522"` - `AllowedCallers []string` - `const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool` When true, guarantees schema validation on tool names and inputs ### Beta Code Execution Tool 20250825 - `type BetaCodeExecutionTool20250825 struct{…}` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const CodeExecutionCodeExecution CodeExecution = "code_execution"` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `AllowedCallers []string` - `const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool` When true, guarantees schema validation on tool names and inputs ### Beta Code Execution Tool 20260120 - `type BetaCodeExecutionTool20260120 struct{…}` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const CodeExecutionCodeExecution CodeExecution = "code_execution"` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` - `AllowedCallers []string` - `const BetaCodeExecutionTool20260120AllowedCallerDirect BetaCodeExecutionTool20260120AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool` When true, guarantees schema validation on tool names and inputs ### Beta Code Execution Tool Result Block - `type BetaCodeExecutionToolResultBlock struct{…}` - `Content BetaCodeExecutionToolResultBlockContentUnion` Code execution result with encrypted stdout for PFC + web_search results. - `type BetaCodeExecutionToolResultError struct{…}` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `Type CodeExecutionToolResultError` - `const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"` - `type BetaCodeExecutionResultBlock struct{…}` - `Content []BetaCodeExecutionOutputBlock` - `FileID string` - `Type CodeExecutionOutput` - `const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type CodeExecutionResult` - `const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"` - `type BetaEncryptedCodeExecutionResultBlock struct{…}` Code execution result with encrypted stdout for PFC + web_search results. - `Content []BetaCodeExecutionOutputBlock` - `FileID string` - `Type CodeExecutionOutput` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `Type EncryptedCodeExecutionResult` - `const EncryptedCodeExecutionResultEncryptedCodeExecutionResult EncryptedCodeExecutionResult = "encrypted_code_execution_result"` - `ToolUseID string` - `Type CodeExecutionToolResult` - `const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"` ### Beta Code Execution Tool Result Block Content - `type BetaCodeExecutionToolResultBlockContentUnion interface{…}` Code execution result with encrypted stdout for PFC + web_search results. - `type BetaCodeExecutionToolResultError struct{…}` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `Type CodeExecutionToolResultError` - `const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"` - `type BetaCodeExecutionResultBlock struct{…}` - `Content []BetaCodeExecutionOutputBlock` - `FileID string` - `Type CodeExecutionOutput` - `const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type CodeExecutionResult` - `const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"` - `type BetaEncryptedCodeExecutionResultBlock struct{…}` Code execution result with encrypted stdout for PFC + web_search results. - `Content []BetaCodeExecutionOutputBlock` - `FileID string` - `Type CodeExecutionOutput` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `Type EncryptedCodeExecutionResult` - `const EncryptedCodeExecutionResultEncryptedCodeExecutionResult EncryptedCodeExecutionResult = "encrypted_code_execution_result"` ### Beta Code Execution Tool Result Block Param - `type BetaCodeExecutionToolResultBlockParamResp struct{…}` - `Content BetaCodeExecutionToolResultBlockParamContentUnionResp` Code execution result with encrypted stdout for PFC + web_search results. - `type BetaCodeExecutionToolResultErrorParamResp struct{…}` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `Type CodeExecutionToolResultError` - `const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"` - `type BetaCodeExecutionResultBlockParamResp struct{…}` - `Content []BetaCodeExecutionOutputBlockParamResp` - `FileID string` - `Type CodeExecutionOutput` - `const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type CodeExecutionResult` - `const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"` - `type BetaEncryptedCodeExecutionResultBlockParamResp struct{…}` Code execution result with encrypted stdout for PFC + web_search results. - `Content []BetaCodeExecutionOutputBlockParamResp` - `FileID string` - `Type CodeExecutionOutput` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `Type EncryptedCodeExecutionResult` - `const EncryptedCodeExecutionResultEncryptedCodeExecutionResult EncryptedCodeExecutionResult = "encrypted_code_execution_result"` - `ToolUseID string` - `Type CodeExecutionToolResult` - `const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` ### Beta Code Execution Tool Result Block Param Content - `type BetaCodeExecutionToolResultBlockParamContentUnionResp interface{…}` Code execution result with encrypted stdout for PFC + web_search results. - `type BetaCodeExecutionToolResultErrorParamResp struct{…}` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `Type CodeExecutionToolResultError` - `const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"` - `type BetaCodeExecutionResultBlockParamResp struct{…}` - `Content []BetaCodeExecutionOutputBlockParamResp` - `FileID string` - `Type CodeExecutionOutput` - `const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type CodeExecutionResult` - `const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"` - `type BetaEncryptedCodeExecutionResultBlockParamResp struct{…}` Code execution result with encrypted stdout for PFC + web_search results. - `Content []BetaCodeExecutionOutputBlockParamResp` - `FileID string` - `Type CodeExecutionOutput` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `Type EncryptedCodeExecutionResult` - `const EncryptedCodeExecutionResultEncryptedCodeExecutionResult EncryptedCodeExecutionResult = "encrypted_code_execution_result"` ### Beta Code Execution Tool Result Error - `type BetaCodeExecutionToolResultError struct{…}` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `Type CodeExecutionToolResultError` - `const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"` ### Beta Code Execution Tool Result Error Code - `type BetaCodeExecutionToolResultErrorCode string` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` ### Beta Code Execution Tool Result Error Param - `type BetaCodeExecutionToolResultErrorParamResp struct{…}` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `Type CodeExecutionToolResultError` - `const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"` ### Beta Compact 20260112 Edit - `type BetaCompact20260112Edit struct{…}` Automatically compact older context when reaching the configured trigger threshold. - `Type Compact20260112` - `const Compact20260112Compact20260112 Compact20260112 = "compact_20260112"` - `Instructions string` Additional instructions for summarization. - `PauseAfterCompaction bool` Whether to pause after compaction and return the compaction block to the user. - `Trigger BetaInputTokensTrigger` When to trigger compaction. Defaults to 150000 input tokens. - `Type InputTokens` - `const InputTokensInputTokens InputTokens = "input_tokens"` - `Value int64` ### Beta Compaction Block - `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 - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `Type Compaction` - `const CompactionCompaction Compaction = "compaction"` ### Beta Compaction Block Param - `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. - `Type Compaction` - `const CompactionCompaction Compaction = "compaction"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Content string` Summary of previously compacted content, or null if compaction failed - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim ### Beta Compaction Content Block Delta - `type BetaCompactionContentBlockDelta struct{…}` - `Content string` - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `Type CompactionDelta` - `const CompactionDeltaCompactionDelta CompactionDelta = "compaction_delta"` ### Beta Compaction Iteration Usage - `type BetaCompactionIterationUsage struct{…}` Token usage for a compaction iteration. - `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 - `const CompactionCompaction Compaction = "compaction"` ### Beta Container - `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 []BetaSkill` Skills loaded in the container - `SkillID string` Skill ID - `Type BetaSkillType` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `const BetaSkillTypeAnthropic BetaSkillType = "anthropic"` - `const BetaSkillTypeCustom BetaSkillType = "custom"` - `Version string` Skill version or 'latest' for most recent version ### Beta Container Params - `type BetaContainerParamsResp struct{…}` Container parameters with skills to be loaded. - `ID string` Container id - `Skills []BetaSkillParamsResp` List of skills to load in the container - `SkillID string` Skill ID - `Type BetaSkillParamsType` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `const BetaSkillParamsTypeAnthropic BetaSkillParamsType = "anthropic"` - `const BetaSkillParamsTypeCustom BetaSkillParamsType = "custom"` - `Version string` Skill version or 'latest' for most recent version ### Beta Container Upload Block - `type BetaContainerUploadBlock struct{…}` Response model for a file uploaded to the container. - `FileID string` - `Type ContainerUpload` - `const ContainerUploadContainerUpload ContainerUpload = "container_upload"` ### Beta Container Upload Block Param - `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` - `const ContainerUploadContainerUpload ContainerUpload = "container_upload"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` ### Beta Content Block - `type BetaContentBlockUnion interface{…}` Response model for a file uploaded to the container. - `type BetaTextBlock struct{…}` - `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`. - `type BetaCitationCharLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationsWebSearchResultLocation struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `Text string` - `Type Text` - `const TextText Text = "text"` - `type BetaThinkingBlock struct{…}` - `Signature string` - `Thinking string` - `Type Thinking` - `const ThinkingThinking Thinking = "thinking"` - `type BetaRedactedThinkingBlock struct{…}` - `Data string` - `Type RedactedThinking` - `const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"` - `type BetaToolUseBlock struct{…}` - `ID string` - `Input map[string, any]` - `Name string` - `Type ToolUse` - `const ToolUseToolUse ToolUse = "tool_use"` - `Caller BetaToolUseBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `Type Direct` - `const DirectDirect Direct = "direct"` - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `ToolID string` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `type BetaServerToolCaller20260120 struct{…}` - `ToolID string` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` - `type BetaServerToolUseBlock struct{…}` - `ID string` - `Input map[string, any]` - `Name BetaServerToolUseBlockName` - `const BetaServerToolUseBlockNameAdvisor BetaServerToolUseBlockName = "advisor"` - `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` - `const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"` - `Caller BetaServerToolUseBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebSearchToolResultBlock struct{…}` - `Content BetaWebSearchToolResultBlockContentUnion` - `type BetaWebSearchToolResultError struct{…}` - `ErrorCode BetaWebSearchToolResultErrorCode` - `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` - `const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"` - `type BetaWebSearchToolResultBlockContentArray []BetaWebSearchResultBlock` - `EncryptedContent string` - `PageAge string` - `Title string` - `Type WebSearchResult` - `const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"` - `URL string` - `ToolUseID string` - `Type WebSearchToolResult` - `const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"` - `Caller BetaWebSearchToolResultBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebFetchToolResultBlock struct{…}` - `Content BetaWebFetchToolResultBlockContentUnion` - `type BetaWebFetchToolResultErrorBlock struct{…}` - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `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` - `const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"` - `type BetaWebFetchBlock struct{…}` - `Content BetaDocumentBlock` - `Citations BetaCitationConfig` Citation configuration for the document - `Enabled bool` - `Source BetaDocumentBlockSourceUnion` - `type BetaBase64PDFSource struct{…}` - `Data string` - `MediaType ApplicationPDF` - `const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaPlainTextSource struct{…}` - `Data string` - `MediaType TextPlain` - `const TextPlainTextPlain TextPlain = "text/plain"` - `Type Text` - `const TextText Text = "text"` - `Title string` The title of the document - `Type Document` - `const DocumentDocument Document = "document"` - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved - `Type WebFetchResult` - `const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"` - `URL string` Fetched content URL - `ToolUseID string` - `Type WebFetchToolResult` - `const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"` - `Caller BetaWebFetchToolResultBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaAdvisorToolResultBlock struct{…}` - `Content BetaAdvisorToolResultBlockContentUnion` - `type BetaAdvisorToolResultError struct{…}` - `ErrorCode BetaAdvisorToolResultErrorErrorCode` - `const BetaAdvisorToolResultErrorErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodePromptTooLong BetaAdvisorToolResultErrorErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorErrorCodeTooManyRequests BetaAdvisorToolResultErrorErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorErrorCodeOverloaded BetaAdvisorToolResultErrorErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorErrorCodeUnavailable BetaAdvisorToolResultErrorErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorErrorCode = "execution_time_exceeded"` - `Type AdvisorToolResultError` - `const AdvisorToolResultErrorAdvisorToolResultError AdvisorToolResultError = "advisor_tool_result_error"` - `type BetaAdvisorResultBlock struct{…}` - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `Text string` - `Type AdvisorResult` - `const AdvisorResultAdvisorResult AdvisorResult = "advisor_result"` - `type BetaAdvisorRedactedResultBlock struct{…}` - `EncryptedContent string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `Type AdvisorRedactedResult` - `const AdvisorRedactedResultAdvisorRedactedResult AdvisorRedactedResult = "advisor_redacted_result"` - `ToolUseID string` - `Type AdvisorToolResult` - `const AdvisorToolResultAdvisorToolResult AdvisorToolResult = "advisor_tool_result"` - `type BetaCodeExecutionToolResultBlock struct{…}` - `Content BetaCodeExecutionToolResultBlockContentUnion` Code execution result with encrypted stdout for PFC + web_search results. - `type BetaCodeExecutionToolResultError struct{…}` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `Type CodeExecutionToolResultError` - `const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"` - `type BetaCodeExecutionResultBlock struct{…}` - `Content []BetaCodeExecutionOutputBlock` - `FileID string` - `Type CodeExecutionOutput` - `const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type CodeExecutionResult` - `const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"` - `type BetaEncryptedCodeExecutionResultBlock struct{…}` Code execution result with encrypted stdout for PFC + web_search results. - `Content []BetaCodeExecutionOutputBlock` - `FileID string` - `Type CodeExecutionOutput` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `Type EncryptedCodeExecutionResult` - `const EncryptedCodeExecutionResultEncryptedCodeExecutionResult EncryptedCodeExecutionResult = "encrypted_code_execution_result"` - `ToolUseID string` - `Type CodeExecutionToolResult` - `const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"` - `type BetaBashCodeExecutionToolResultBlock struct{…}` - `Content BetaBashCodeExecutionToolResultBlockContentUnion` - `type BetaBashCodeExecutionToolResultError struct{…}` - `ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode` - `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` - `const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"` - `type BetaBashCodeExecutionResultBlock struct{…}` - `Content []BetaBashCodeExecutionOutputBlock` - `FileID string` - `Type BashCodeExecutionOutput` - `const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type BashCodeExecutionResult` - `const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"` - `ToolUseID string` - `Type BashCodeExecutionToolResult` - `const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"` - `type BetaTextEditorCodeExecutionToolResultBlock struct{…}` - `Content BetaTextEditorCodeExecutionToolResultBlockContentUnion` - `type BetaTextEditorCodeExecutionToolResultError struct{…}` - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode` - `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` - `const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"` - `type BetaTextEditorCodeExecutionViewResultBlock struct{…}` - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockFileType` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` - `Type TextEditorCodeExecutionViewResult` - `const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"` - `type BetaTextEditorCodeExecutionCreateResultBlock struct{…}` - `IsFileUpdate bool` - `Type TextEditorCodeExecutionCreateResult` - `const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"` - `type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}` - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` - `Type TextEditorCodeExecutionStrReplaceResult` - `const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"` - `ToolUseID string` - `Type TextEditorCodeExecutionToolResult` - `const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"` - `type BetaToolSearchToolResultBlock struct{…}` - `Content BetaToolSearchToolResultBlockContentUnion` - `type BetaToolSearchToolResultError struct{…}` - `ErrorCode BetaToolSearchToolResultErrorErrorCode` - `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` - `const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"` - `type BetaToolSearchToolSearchResultBlock struct{…}` - `ToolReferences []BetaToolReferenceBlock` - `ToolName string` - `Type ToolReference` - `const ToolReferenceToolReference ToolReference = "tool_reference"` - `Type ToolSearchToolSearchResult` - `const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"` - `ToolUseID string` - `Type ToolSearchToolResult` - `const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"` - `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` - `const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"` - `type BetaMCPToolResultBlock struct{…}` - `Content BetaMCPToolResultBlockContentUnion` - `string` - `type BetaMCPToolResultBlockContentBetaMCPToolResultBlockContent []BetaTextBlock` - `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`. - `Text string` - `Type Text` - `IsError bool` - `ToolUseID string` - `Type MCPToolResult` - `const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"` - `type BetaContainerUploadBlock struct{…}` Response model for a file uploaded to the container. - `FileID string` - `Type ContainerUpload` - `const ContainerUploadContainerUpload ContainerUpload = "container_upload"` - `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 - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `Type Compaction` - `const CompactionCompaction Compaction = "compaction"` ### Beta Content Block Param - `type BetaContentBlockParamUnionResp interface{…}` Regular text content. - `type BetaTextBlockParamResp struct{…}` - `Text string` - `Type Text` - `const TextText Text = "text"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations []BetaTextCitationParamUnionResp` - `type BetaCitationCharLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationWebSearchResultLocationParamResp struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `type BetaImageBlockParamResp struct{…}` - `Source BetaImageBlockParamSourceUnionResp` - `type BetaBase64ImageSource struct{…}` - `Data string` - `MediaType BetaBase64ImageSourceMediaType` - `const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"` - `const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"` - `const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"` - `const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaURLImageSource struct{…}` - `Type URL` - `const URLURL URL = "url"` - `URL string` - `type BetaFileImageSource struct{…}` - `FileID string` - `Type File` - `const FileFile File = "file"` - `Type Image` - `const ImageImage Image = "image"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaRequestDocumentBlock struct{…}` - `Source BetaRequestDocumentBlockSourceUnion` - `type BetaBase64PDFSource struct{…}` - `Data string` - `MediaType ApplicationPDF` - `const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaPlainTextSource struct{…}` - `Data string` - `MediaType TextPlain` - `const TextPlainTextPlain TextPlain = "text/plain"` - `Type Text` - `const TextText Text = "text"` - `type BetaContentBlockSource struct{…}` - `Content BetaContentBlockSourceContentUnion` - `string` - `[]BetaContentBlockSourceContentUnion` - `type BetaTextBlockParamResp struct{…}` - `type BetaImageBlockParamResp struct{…}` - `Type Content` - `const ContentContent Content = "content"` - `type BetaURLPDFSource struct{…}` - `Type URL` - `const URLURL URL = "url"` - `URL string` - `type BetaFileDocumentSource struct{…}` - `FileID string` - `Type File` - `const FileFile File = "file"` - `Type Document` - `const DocumentDocument Document = "document"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` - `Enabled bool` - `Context string` - `Title string` - `type BetaSearchResultBlockParamResp struct{…}` - `Content []BetaTextBlockParamResp` - `Text string` - `Type Text` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnionResp` - `Source string` - `Title string` - `Type SearchResult` - `const SearchResultSearchResult SearchResult = "search_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` - `type BetaThinkingBlockParamResp struct{…}` - `Signature string` - `Thinking string` - `Type Thinking` - `const ThinkingThinking Thinking = "thinking"` - `type BetaRedactedThinkingBlockParamResp struct{…}` - `Data string` - `Type RedactedThinking` - `const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"` - `type BetaToolUseBlockParamResp struct{…}` - `ID string` - `Input map[string, any]` - `Name string` - `Type ToolUse` - `const ToolUseToolUse ToolUse = "tool_use"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Caller BetaToolUseBlockParamCallerUnionResp` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `Type Direct` - `const DirectDirect Direct = "direct"` - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `ToolID string` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `type BetaServerToolCaller20260120 struct{…}` - `ToolID string` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` - `type BetaToolResultBlockParamResp struct{…}` - `ToolUseID string` - `Type ToolResult` - `const ToolResultToolResult ToolResult = "tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Content []BetaToolResultBlockParamContentUnionResp` - `[]BetaToolResultBlockParamContentUnionResp` - `type BetaTextBlockParamResp struct{…}` - `type BetaImageBlockParamResp struct{…}` - `type BetaSearchResultBlockParamResp struct{…}` - `type BetaRequestDocumentBlock struct{…}` - `type BetaToolReferenceBlockParamResp struct{…}` Tool reference block that can be included in tool_result content. - `ToolName string` - `Type ToolReference` - `const ToolReferenceToolReference ToolReference = "tool_reference"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `IsError bool` - `type BetaServerToolUseBlockParamResp struct{…}` - `ID string` - `Input map[string, any]` - `Name BetaServerToolUseBlockParamName` - `const BetaServerToolUseBlockParamNameAdvisor BetaServerToolUseBlockParamName = "advisor"` - `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` - `const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Caller BetaServerToolUseBlockParamCallerUnionResp` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebSearchToolResultBlockParamResp struct{…}` - `Content BetaWebSearchToolResultBlockParamContentUnionResp` - `[]BetaWebSearchResultBlockParamResp` - `EncryptedContent string` - `Title string` - `Type WebSearchResult` - `const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"` - `URL string` - `PageAge string` - `type BetaWebSearchToolRequestError struct{…}` - `ErrorCode BetaWebSearchToolResultErrorCode` - `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` - `const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"` - `ToolUseID string` - `Type WebSearchToolResult` - `const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Caller BetaWebSearchToolResultBlockParamCallerUnionResp` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebFetchToolResultBlockParamResp struct{…}` - `Content BetaWebFetchToolResultBlockParamContentUnionResp` - `type BetaWebFetchToolResultErrorBlockParamResp struct{…}` - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `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` - `const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"` - `type BetaWebFetchBlockParamResp struct{…}` - `Content BetaRequestDocumentBlock` - `Type WebFetchResult` - `const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"` - `URL string` Fetched content URL - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved - `ToolUseID string` - `Type WebFetchToolResult` - `const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Caller BetaWebFetchToolResultBlockParamCallerUnionResp` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaAdvisorToolResultBlockParamResp struct{…}` - `Content BetaAdvisorToolResultBlockParamContentUnionResp` - `type BetaAdvisorToolResultErrorParamResp struct{…}` - `ErrorCode BetaAdvisorToolResultErrorParamErrorCode` - `const BetaAdvisorToolResultErrorParamErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorParamErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorParamErrorCodePromptTooLong BetaAdvisorToolResultErrorParamErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorParamErrorCodeTooManyRequests BetaAdvisorToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorParamErrorCodeOverloaded BetaAdvisorToolResultErrorParamErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorParamErrorCodeUnavailable BetaAdvisorToolResultErrorParamErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorParamErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorParamErrorCode = "execution_time_exceeded"` - `Type AdvisorToolResultError` - `const AdvisorToolResultErrorAdvisorToolResultError AdvisorToolResultError = "advisor_tool_result_error"` - `type BetaAdvisorResultBlockParamResp struct{…}` - `Text string` - `Type AdvisorResult` - `const AdvisorResultAdvisorResult AdvisorResult = "advisor_result"` - `StopReason string` - `type BetaAdvisorRedactedResultBlockParamResp struct{…}` - `EncryptedContent string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `Type AdvisorRedactedResult` - `const AdvisorRedactedResultAdvisorRedactedResult AdvisorRedactedResult = "advisor_redacted_result"` - `StopReason string` - `ToolUseID string` - `Type AdvisorToolResult` - `const AdvisorToolResultAdvisorToolResult AdvisorToolResult = "advisor_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaCodeExecutionToolResultBlockParamResp struct{…}` - `Content BetaCodeExecutionToolResultBlockParamContentUnionResp` Code execution result with encrypted stdout for PFC + web_search results. - `type BetaCodeExecutionToolResultErrorParamResp struct{…}` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `Type CodeExecutionToolResultError` - `const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"` - `type BetaCodeExecutionResultBlockParamResp struct{…}` - `Content []BetaCodeExecutionOutputBlockParamResp` - `FileID string` - `Type CodeExecutionOutput` - `const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type CodeExecutionResult` - `const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"` - `type BetaEncryptedCodeExecutionResultBlockParamResp struct{…}` Code execution result with encrypted stdout for PFC + web_search results. - `Content []BetaCodeExecutionOutputBlockParamResp` - `FileID string` - `Type CodeExecutionOutput` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `Type EncryptedCodeExecutionResult` - `const EncryptedCodeExecutionResultEncryptedCodeExecutionResult EncryptedCodeExecutionResult = "encrypted_code_execution_result"` - `ToolUseID string` - `Type CodeExecutionToolResult` - `const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaBashCodeExecutionToolResultBlockParamResp struct{…}` - `Content BetaBashCodeExecutionToolResultBlockParamContentUnionResp` - `type BetaBashCodeExecutionToolResultErrorParamResp struct{…}` - `ErrorCode BetaBashCodeExecutionToolResultErrorParamErrorCode` - `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` - `const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"` - `type BetaBashCodeExecutionResultBlockParamResp struct{…}` - `Content []BetaBashCodeExecutionOutputBlockParamResp` - `FileID string` - `Type BashCodeExecutionOutput` - `const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type BashCodeExecutionResult` - `const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"` - `ToolUseID string` - `Type BashCodeExecutionToolResult` - `const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaTextEditorCodeExecutionToolResultBlockParamResp struct{…}` - `Content BetaTextEditorCodeExecutionToolResultBlockParamContentUnionResp` - `type BetaTextEditorCodeExecutionToolResultErrorParamResp struct{…}` - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorParamErrorCode` - `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` - `const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"` - `ErrorMessage string` - `type BetaTextEditorCodeExecutionViewResultBlockParamResp struct{…}` - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockParamFileType` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeText BetaTextEditorCodeExecutionViewResultBlockParamFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeImage BetaTextEditorCodeExecutionViewResultBlockParamFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypePDF BetaTextEditorCodeExecutionViewResultBlockParamFileType = "pdf"` - `Type TextEditorCodeExecutionViewResult` - `const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` - `type BetaTextEditorCodeExecutionCreateResultBlockParamResp struct{…}` - `IsFileUpdate bool` - `Type TextEditorCodeExecutionCreateResult` - `const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"` - `type BetaTextEditorCodeExecutionStrReplaceResultBlockParamResp struct{…}` - `Type TextEditorCodeExecutionStrReplaceResult` - `const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"` - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` - `ToolUseID string` - `Type TextEditorCodeExecutionToolResult` - `const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaToolSearchToolResultBlockParamResp struct{…}` - `Content BetaToolSearchToolResultBlockParamContentUnionResp` - `type BetaToolSearchToolResultErrorParamResp struct{…}` - `ErrorCode BetaToolSearchToolResultErrorParamErrorCode` - `const BetaToolSearchToolResultErrorParamErrorCodeInvalidToolInput BetaToolSearchToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaToolSearchToolResultErrorParamErrorCodeUnavailable BetaToolSearchToolResultErrorParamErrorCode = "unavailable"` - `const BetaToolSearchToolResultErrorParamErrorCodeTooManyRequests BetaToolSearchToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaToolSearchToolResultErrorParamErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorParamErrorCode = "execution_time_exceeded"` - `Type ToolSearchToolResultError` - `const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"` - `type BetaToolSearchToolSearchResultBlockParamResp struct{…}` - `ToolReferences []BetaToolReferenceBlockParamResp` - `ToolName string` - `Type ToolReference` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type ToolSearchToolSearchResult` - `const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"` - `ToolUseID string` - `Type ToolSearchToolResult` - `const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaMCPToolUseBlockParamResp struct{…}` - `ID string` - `Input map[string, any]` - `Name string` - `ServerName string` The name of the MCP server - `Type MCPToolUse` - `const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaRequestMCPToolResultBlockParamResp struct{…}` - `ToolUseID string` - `Type MCPToolResult` - `const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Content BetaRequestMCPToolResultBlockParamContentUnionResp` - `string` - `[]BetaTextBlockParamResp` - `Text string` - `Type Text` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnionResp` - `IsError bool` - `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` - `const ContainerUploadContainerUpload ContainerUpload = "container_upload"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `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. - `Type Compaction` - `const CompactionCompaction Compaction = "compaction"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Content string` Summary of previously compacted content, or null if compaction failed - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `type BetaMidConversationSystemBlockParamResp struct{…}` System instructions that appear mid-conversation. Use this block to provide or update system-level instructions at a specific point in the conversation, rather than only via the top-level `system` parameter. - `Content []BetaTextBlockParamResp` System instruction text blocks. - `Text string` - `Type Text` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnionResp` - `Type MidConvSystem` - `const MidConvSystemMidConvSystem MidConvSystem = "mid_conv_system"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. ### Beta Content Block Source - `type BetaContentBlockSource struct{…}` - `Content BetaContentBlockSourceContentUnion` - `string` - `[]BetaContentBlockSourceContentUnion` - `type BetaTextBlockParamResp struct{…}` - `Text string` - `Type Text` - `const TextText Text = "text"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations []BetaTextCitationParamUnionResp` - `type BetaCitationCharLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationWebSearchResultLocationParamResp struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `type BetaImageBlockParamResp struct{…}` - `Source BetaImageBlockParamSourceUnionResp` - `type BetaBase64ImageSource struct{…}` - `Data string` - `MediaType BetaBase64ImageSourceMediaType` - `const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"` - `const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"` - `const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"` - `const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaURLImageSource struct{…}` - `Type URL` - `const URLURL URL = "url"` - `URL string` - `type BetaFileImageSource struct{…}` - `FileID string` - `Type File` - `const FileFile File = "file"` - `Type Image` - `const ImageImage Image = "image"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Content` - `const ContentContent Content = "content"` ### Beta Content Block Source Content - `type BetaContentBlockSourceContentUnion interface{…}` - `type BetaTextBlockParamResp struct{…}` - `Text string` - `Type Text` - `const TextText Text = "text"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations []BetaTextCitationParamUnionResp` - `type BetaCitationCharLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationWebSearchResultLocationParamResp struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `type BetaImageBlockParamResp struct{…}` - `Source BetaImageBlockParamSourceUnionResp` - `type BetaBase64ImageSource struct{…}` - `Data string` - `MediaType BetaBase64ImageSourceMediaType` - `const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"` - `const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"` - `const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"` - `const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaURLImageSource struct{…}` - `Type URL` - `const URLURL URL = "url"` - `URL string` - `type BetaFileImageSource struct{…}` - `FileID string` - `Type File` - `const FileFile File = "file"` - `Type Image` - `const ImageImage Image = "image"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. ### Beta Context Management Config - `type BetaContextManagementConfig struct{…}` - `Edits []BetaContextManagementConfigEditUnion` List of context management edits to apply - `type BetaClearToolUses20250919Edit struct{…}` - `Type ClearToolUses20250919` - `const ClearToolUses20250919ClearToolUses20250919 ClearToolUses20250919 = "clear_tool_uses_20250919"` - `ClearAtLeast BetaInputTokensClearAtLeast` Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed. - `Type InputTokens` - `const InputTokensInputTokens InputTokens = "input_tokens"` - `Value int64` - `ClearToolInputs BetaClearToolUses20250919EditClearToolInputsUnion` Whether to clear all tool inputs (bool) or specific tool inputs to clear (list) - `bool` - `[]string` - `ExcludeTools []string` Tool names whose uses are preserved from clearing - `Keep BetaToolUsesKeep` Number of tool uses to retain in the conversation - `Type ToolUses` - `const ToolUsesToolUses ToolUses = "tool_uses"` - `Value int64` - `Trigger BetaClearToolUses20250919EditTriggerUnion` Condition that triggers the context management strategy - `type BetaInputTokensTrigger struct{…}` - `Type InputTokens` - `const InputTokensInputTokens InputTokens = "input_tokens"` - `Value int64` - `type BetaToolUsesTrigger struct{…}` - `Type ToolUses` - `const ToolUsesToolUses ToolUses = "tool_uses"` - `Value int64` - `type BetaClearThinking20251015Edit struct{…}` - `Type ClearThinking20251015` - `const ClearThinking20251015ClearThinking20251015 ClearThinking20251015 = "clear_thinking_20251015"` - `Keep BetaClearThinking20251015EditKeepUnion` Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed. - `type BetaThinkingTurns struct{…}` - `Type ThinkingTurns` - `const ThinkingTurnsThinkingTurns ThinkingTurns = "thinking_turns"` - `Value int64` - `type BetaAllThinkingTurns struct{…}` - `Type All` - `const AllAll All = "all"` - `All` - `const AllAll All = "all"` - `type BetaCompact20260112Edit struct{…}` Automatically compact older context when reaching the configured trigger threshold. - `Type Compact20260112` - `const Compact20260112Compact20260112 Compact20260112 = "compact_20260112"` - `Instructions string` Additional instructions for summarization. - `PauseAfterCompaction bool` Whether to pause after compaction and return the compaction block to the user. - `Trigger BetaInputTokensTrigger` When to trigger compaction. Defaults to 150000 input tokens. ### Beta Context Management Response - `type BetaContextManagementResponse struct{…}` - `AppliedEdits []BetaContextManagementResponseAppliedEditUnion` List of context management edits that were applied. - `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. - `const ClearToolUses20250919ClearToolUses20250919 ClearToolUses20250919 = "clear_tool_uses_20250919"` - `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. - `const ClearThinking20251015ClearThinking20251015 ClearThinking20251015 = "clear_thinking_20251015"` ### Beta Count Tokens Context Management Response - `type BetaCountTokensContextManagementResponse struct{…}` - `OriginalInputTokens int64` The original token count before context management was applied ### Beta Diagnostics - `type BetaDiagnostics struct{…}` Response envelope for request-level diagnostics. Present (possibly null) whenever the caller supplied `diagnostics` on the request. - `CacheMissReason BetaDiagnosticsCacheMissReasonUnion` Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - `type BetaCacheMissModelChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type ModelChanged` - `const ModelChangedModelChanged ModelChanged = "model_changed"` - `type BetaCacheMissSystemChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type SystemChanged` - `const SystemChangedSystemChanged SystemChanged = "system_changed"` - `type BetaCacheMissToolsChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type ToolsChanged` - `const ToolsChangedToolsChanged ToolsChanged = "tools_changed"` - `type BetaCacheMissMessagesChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type MessagesChanged` - `const MessagesChangedMessagesChanged MessagesChanged = "messages_changed"` - `type BetaCacheMissPreviousMessageNotFound struct{…}` - `Type PreviousMessageNotFound` - `const PreviousMessageNotFoundPreviousMessageNotFound PreviousMessageNotFound = "previous_message_not_found"` - `type BetaCacheMissUnavailable struct{…}` - `Type Unavailable` - `const UnavailableUnavailable Unavailable = "unavailable"` ### Beta Diagnostics Param - `type BetaDiagnosticsParamResp struct{…}` Request-level diagnostics. Currently carries the previous response id for prompt-cache divergence reporting. - `PreviousMessageID string` The `id` (`msg_...`) from this client's previous /v1/messages response. The server compares that request's prompt fingerprint against this one and returns `diagnostics.cache_miss_reason` when the prompt-cache prefix could not be reused. Pass `null` on the first turn to opt in without a prior message to compare. ### Beta Direct Caller - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `Type Direct` - `const DirectDirect Direct = "direct"` ### Beta Document Block - `type BetaDocumentBlock struct{…}` - `Citations BetaCitationConfig` Citation configuration for the document - `Enabled bool` - `Source BetaDocumentBlockSourceUnion` - `type BetaBase64PDFSource struct{…}` - `Data string` - `MediaType ApplicationPDF` - `const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaPlainTextSource struct{…}` - `Data string` - `MediaType TextPlain` - `const TextPlainTextPlain TextPlain = "text/plain"` - `Type Text` - `const TextText Text = "text"` - `Title string` The title of the document - `Type Document` - `const DocumentDocument Document = "document"` ### Beta Encrypted Code Execution Result Block - `type BetaEncryptedCodeExecutionResultBlock struct{…}` Code execution result with encrypted stdout for PFC + web_search results. - `Content []BetaCodeExecutionOutputBlock` - `FileID string` - `Type CodeExecutionOutput` - `const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `Type EncryptedCodeExecutionResult` - `const EncryptedCodeExecutionResultEncryptedCodeExecutionResult EncryptedCodeExecutionResult = "encrypted_code_execution_result"` ### Beta Encrypted Code Execution Result Block Param - `type BetaEncryptedCodeExecutionResultBlockParamResp struct{…}` Code execution result with encrypted stdout for PFC + web_search results. - `Content []BetaCodeExecutionOutputBlockParamResp` - `FileID string` - `Type CodeExecutionOutput` - `const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `Type EncryptedCodeExecutionResult` - `const EncryptedCodeExecutionResultEncryptedCodeExecutionResult EncryptedCodeExecutionResult = "encrypted_code_execution_result"` ### Beta File Document Source - `type BetaFileDocumentSource struct{…}` - `FileID string` - `Type File` - `const FileFile File = "file"` ### Beta File Image Source - `type BetaFileImageSource struct{…}` - `FileID string` - `Type File` - `const FileFile File = "file"` ### Beta Image Block Param - `type BetaImageBlockParamResp struct{…}` - `Source BetaImageBlockParamSourceUnionResp` - `type BetaBase64ImageSource struct{…}` - `Data string` - `MediaType BetaBase64ImageSourceMediaType` - `const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"` - `const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"` - `const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"` - `const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaURLImageSource struct{…}` - `Type URL` - `const URLURL URL = "url"` - `URL string` - `type BetaFileImageSource struct{…}` - `FileID string` - `Type File` - `const FileFile File = "file"` - `Type Image` - `const ImageImage Image = "image"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` ### Beta Input JSON Delta - `type BetaInputJSONDelta struct{…}` - `PartialJSON string` - `Type InputJSONDelta` - `const InputJSONDeltaInputJSONDelta InputJSONDelta = "input_json_delta"` ### Beta Input Tokens Clear At Least - `type BetaInputTokensClearAtLeast struct{…}` - `Type InputTokens` - `const InputTokensInputTokens InputTokens = "input_tokens"` - `Value int64` ### Beta Input Tokens Trigger - `type BetaInputTokensTrigger struct{…}` - `Type InputTokens` - `const InputTokensInputTokens InputTokens = "input_tokens"` - `Value int64` ### Beta Iterations Usage - `type BetaIterationsUsage []BetaIterationsUsageItemUnion` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the true context window size from the last iteration - Understand token accumulation across server-side tool use loops - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. - `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 Message` Usage for a sampling iteration - `const MessageMessage Message = "message"` - `type BetaCompactionIterationUsage struct{…}` Token usage for a compaction iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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 - `const CompactionCompaction Compaction = "compaction"` - `type BetaAdvisorMessageIterationUsage struct{…}` Token usage for an advisor sub-inference iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type Model string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `const ModelClaudeOpus4_1 Model = "claude-opus-4-1"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_0 Model = "claude-opus-4-0"` Powerful model for complex tasks - `const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"` Powerful model for complex tasks - `const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"` High-performance model with extended thinking - `const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"` High-performance model with extended thinking - `const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"` Fast and cost-effective model - `string` - `OutputTokens int64` The number of output tokens which were used. - `Type AdvisorMessage` Usage for an advisor sub-inference iteration - `const AdvisorMessageAdvisorMessage AdvisorMessage = "advisor_message"` ### Beta JSON Output Format - `type BetaJSONOutputFormat struct{…}` - `Schema map[string, any]` The JSON schema of the format - `Type JSONSchema` - `const JSONSchemaJSONSchema JSONSchema = "json_schema"` ### Beta MCP Tool Config - `type BetaMCPToolConfig struct{…}` Configuration for a specific tool in an MCP toolset. - `DeferLoading bool` - `Enabled bool` ### Beta MCP Tool Default Config - `type BetaMCPToolDefaultConfig struct{…}` Default configuration for tools in an MCP toolset. - `DeferLoading bool` - `Enabled bool` ### Beta MCP Tool Result Block - `type BetaMCPToolResultBlock struct{…}` - `Content BetaMCPToolResultBlockContentUnion` - `string` - `type BetaMCPToolResultBlockContentBetaMCPToolResultBlockContent []BetaTextBlock` - `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`. - `type BetaCitationCharLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationsWebSearchResultLocation struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `Text string` - `Type Text` - `const TextText Text = "text"` - `IsError bool` - `ToolUseID string` - `Type MCPToolResult` - `const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"` ### Beta MCP Tool Use Block - `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` - `const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"` ### Beta MCP Tool Use Block Param - `type BetaMCPToolUseBlockParamResp struct{…}` - `ID string` - `Input map[string, any]` - `Name string` - `ServerName string` The name of the MCP server - `Type MCPToolUse` - `const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` ### Beta MCP Toolset - `type BetaMCPToolset struct{…}` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `MCPServerName string` Name of the MCP server to configure tools for - `Type MCPToolset` - `const MCPToolsetMCPToolset MCPToolset = "mcp_toolset"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Configs map[string, BetaMCPToolConfig]` Configuration overrides for specific tools, keyed by tool name - `DeferLoading bool` - `Enabled bool` - `DefaultConfig BetaMCPToolDefaultConfig` Default configuration applied to all tools from this server - `DeferLoading bool` - `Enabled bool` ### Beta Memory Tool 20250818 - `type BetaMemoryTool20250818 struct{…}` - `Name Memory` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const MemoryMemory Memory = "memory"` - `Type Memory20250818` - `const Memory20250818Memory20250818 Memory20250818 = "memory_20250818"` - `AllowedCallers []string` - `const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260120 BetaMemoryTool20250818AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs ### Beta Memory Tool 20250818 Command - `type BetaMemoryTool20250818CommandUnion interface{…}` - `type BetaMemoryTool20250818ViewCommand struct{…}` - `Command View` Command type identifier - `const ViewView View = "view"` - `Path string` Path to directory or file to view - `ViewRange []int64` Optional line range for viewing specific lines - `type BetaMemoryTool20250818CreateCommand struct{…}` - `Command Create` Command type identifier - `const CreateCreate Create = "create"` - `FileText string` Content to write to the file - `Path string` Path where the file should be created - `type BetaMemoryTool20250818StrReplaceCommand struct{…}` - `Command StrReplace` Command type identifier - `const StrReplaceStrReplace StrReplace = "str_replace"` - `NewStr string` Text to replace with - `OldStr string` Text to search for and replace - `Path string` Path to the file where text should be replaced - `type BetaMemoryTool20250818InsertCommand struct{…}` - `Command Insert` Command type identifier - `const InsertInsert Insert = "insert"` - `InsertLine int64` Line number where text should be inserted - `InsertText string` Text to insert at the specified line - `Path string` Path to the file where text should be inserted - `type BetaMemoryTool20250818DeleteCommand struct{…}` - `Command Delete` Command type identifier - `const DeleteDelete Delete = "delete"` - `Path string` Path to the file or directory to delete - `type BetaMemoryTool20250818RenameCommand struct{…}` - `Command Rename` Command type identifier - `const RenameRename Rename = "rename"` - `NewPath string` New path for the file or directory - `OldPath string` Current path of the file or directory ### Beta Memory Tool 20250818 Create Command - `type BetaMemoryTool20250818CreateCommand struct{…}` - `Command Create` Command type identifier - `const CreateCreate Create = "create"` - `FileText string` Content to write to the file - `Path string` Path where the file should be created ### Beta Memory Tool 20250818 Delete Command - `type BetaMemoryTool20250818DeleteCommand struct{…}` - `Command Delete` Command type identifier - `const DeleteDelete Delete = "delete"` - `Path string` Path to the file or directory to delete ### Beta Memory Tool 20250818 Insert Command - `type BetaMemoryTool20250818InsertCommand struct{…}` - `Command Insert` Command type identifier - `const InsertInsert Insert = "insert"` - `InsertLine int64` Line number where text should be inserted - `InsertText string` Text to insert at the specified line - `Path string` Path to the file where text should be inserted ### Beta Memory Tool 20250818 Rename Command - `type BetaMemoryTool20250818RenameCommand struct{…}` - `Command Rename` Command type identifier - `const RenameRename Rename = "rename"` - `NewPath string` New path for the file or directory - `OldPath string` Current path of the file or directory ### Beta Memory Tool 20250818 Str Replace Command - `type BetaMemoryTool20250818StrReplaceCommand struct{…}` - `Command StrReplace` Command type identifier - `const StrReplaceStrReplace StrReplace = "str_replace"` - `NewStr string` Text to replace with - `OldStr string` Text to search for and replace - `Path string` Path to the file where text should be replaced ### Beta Memory Tool 20250818 View Command - `type BetaMemoryTool20250818ViewCommand struct{…}` - `Command View` Command type identifier - `const ViewView View = "view"` - `Path string` Path to directory or file to view - `ViewRange []int64` Optional line range for viewing specific lines ### Beta Message - `type BetaMessage struct{…}` - `ID string` Unique object identifier. The format and length of IDs may change over time. - `Container BetaContainer` Information about the container used in the request (for the code execution tool) - `ID string` Identifier for the container used in this request - `ExpiresAt Time` The time at which the container will expire. - `Skills []BetaSkill` Skills loaded in the container - `SkillID string` Skill ID - `Type BetaSkillType` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `const BetaSkillTypeAnthropic BetaSkillType = "anthropic"` - `const BetaSkillTypeCustom BetaSkillType = "custom"` - `Version string` Skill version or 'latest' for most recent version - `Content []BetaContentBlockUnion` Content generated by the model. This is an array of content blocks, each of which has a `type` that determines its shape. Example: ```json [{"type": "text", "text": "Hi, I'm Claude."}] ``` If the request input `messages` ended with an `assistant` turn, then the response `content` will continue directly from that last turn. You can use this to constrain the model's output. For example, if the input `messages` were: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("} ] ``` Then the response `content` might be: ```json [{"type": "text", "text": "B)"}] ``` - `type BetaTextBlock struct{…}` - `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`. - `type BetaCitationCharLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationsWebSearchResultLocation struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `Text string` - `Type Text` - `const TextText Text = "text"` - `type BetaThinkingBlock struct{…}` - `Signature string` - `Thinking string` - `Type Thinking` - `const ThinkingThinking Thinking = "thinking"` - `type BetaRedactedThinkingBlock struct{…}` - `Data string` - `Type RedactedThinking` - `const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"` - `type BetaToolUseBlock struct{…}` - `ID string` - `Input map[string, any]` - `Name string` - `Type ToolUse` - `const ToolUseToolUse ToolUse = "tool_use"` - `Caller BetaToolUseBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `Type Direct` - `const DirectDirect Direct = "direct"` - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `ToolID string` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `type BetaServerToolCaller20260120 struct{…}` - `ToolID string` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` - `type BetaServerToolUseBlock struct{…}` - `ID string` - `Input map[string, any]` - `Name BetaServerToolUseBlockName` - `const BetaServerToolUseBlockNameAdvisor BetaServerToolUseBlockName = "advisor"` - `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` - `const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"` - `Caller BetaServerToolUseBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebSearchToolResultBlock struct{…}` - `Content BetaWebSearchToolResultBlockContentUnion` - `type BetaWebSearchToolResultError struct{…}` - `ErrorCode BetaWebSearchToolResultErrorCode` - `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` - `const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"` - `type BetaWebSearchToolResultBlockContentArray []BetaWebSearchResultBlock` - `EncryptedContent string` - `PageAge string` - `Title string` - `Type WebSearchResult` - `const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"` - `URL string` - `ToolUseID string` - `Type WebSearchToolResult` - `const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"` - `Caller BetaWebSearchToolResultBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebFetchToolResultBlock struct{…}` - `Content BetaWebFetchToolResultBlockContentUnion` - `type BetaWebFetchToolResultErrorBlock struct{…}` - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `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` - `const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"` - `type BetaWebFetchBlock struct{…}` - `Content BetaDocumentBlock` - `Citations BetaCitationConfig` Citation configuration for the document - `Enabled bool` - `Source BetaDocumentBlockSourceUnion` - `type BetaBase64PDFSource struct{…}` - `Data string` - `MediaType ApplicationPDF` - `const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaPlainTextSource struct{…}` - `Data string` - `MediaType TextPlain` - `const TextPlainTextPlain TextPlain = "text/plain"` - `Type Text` - `const TextText Text = "text"` - `Title string` The title of the document - `Type Document` - `const DocumentDocument Document = "document"` - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved - `Type WebFetchResult` - `const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"` - `URL string` Fetched content URL - `ToolUseID string` - `Type WebFetchToolResult` - `const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"` - `Caller BetaWebFetchToolResultBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaAdvisorToolResultBlock struct{…}` - `Content BetaAdvisorToolResultBlockContentUnion` - `type BetaAdvisorToolResultError struct{…}` - `ErrorCode BetaAdvisorToolResultErrorErrorCode` - `const BetaAdvisorToolResultErrorErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodePromptTooLong BetaAdvisorToolResultErrorErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorErrorCodeTooManyRequests BetaAdvisorToolResultErrorErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorErrorCodeOverloaded BetaAdvisorToolResultErrorErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorErrorCodeUnavailable BetaAdvisorToolResultErrorErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorErrorCode = "execution_time_exceeded"` - `Type AdvisorToolResultError` - `const AdvisorToolResultErrorAdvisorToolResultError AdvisorToolResultError = "advisor_tool_result_error"` - `type BetaAdvisorResultBlock struct{…}` - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `Text string` - `Type AdvisorResult` - `const AdvisorResultAdvisorResult AdvisorResult = "advisor_result"` - `type BetaAdvisorRedactedResultBlock struct{…}` - `EncryptedContent string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `Type AdvisorRedactedResult` - `const AdvisorRedactedResultAdvisorRedactedResult AdvisorRedactedResult = "advisor_redacted_result"` - `ToolUseID string` - `Type AdvisorToolResult` - `const AdvisorToolResultAdvisorToolResult AdvisorToolResult = "advisor_tool_result"` - `type BetaCodeExecutionToolResultBlock struct{…}` - `Content BetaCodeExecutionToolResultBlockContentUnion` Code execution result with encrypted stdout for PFC + web_search results. - `type BetaCodeExecutionToolResultError struct{…}` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `Type CodeExecutionToolResultError` - `const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"` - `type BetaCodeExecutionResultBlock struct{…}` - `Content []BetaCodeExecutionOutputBlock` - `FileID string` - `Type CodeExecutionOutput` - `const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type CodeExecutionResult` - `const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"` - `type BetaEncryptedCodeExecutionResultBlock struct{…}` Code execution result with encrypted stdout for PFC + web_search results. - `Content []BetaCodeExecutionOutputBlock` - `FileID string` - `Type CodeExecutionOutput` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `Type EncryptedCodeExecutionResult` - `const EncryptedCodeExecutionResultEncryptedCodeExecutionResult EncryptedCodeExecutionResult = "encrypted_code_execution_result"` - `ToolUseID string` - `Type CodeExecutionToolResult` - `const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"` - `type BetaBashCodeExecutionToolResultBlock struct{…}` - `Content BetaBashCodeExecutionToolResultBlockContentUnion` - `type BetaBashCodeExecutionToolResultError struct{…}` - `ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode` - `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` - `const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"` - `type BetaBashCodeExecutionResultBlock struct{…}` - `Content []BetaBashCodeExecutionOutputBlock` - `FileID string` - `Type BashCodeExecutionOutput` - `const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type BashCodeExecutionResult` - `const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"` - `ToolUseID string` - `Type BashCodeExecutionToolResult` - `const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"` - `type BetaTextEditorCodeExecutionToolResultBlock struct{…}` - `Content BetaTextEditorCodeExecutionToolResultBlockContentUnion` - `type BetaTextEditorCodeExecutionToolResultError struct{…}` - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode` - `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` - `const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"` - `type BetaTextEditorCodeExecutionViewResultBlock struct{…}` - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockFileType` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` - `Type TextEditorCodeExecutionViewResult` - `const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"` - `type BetaTextEditorCodeExecutionCreateResultBlock struct{…}` - `IsFileUpdate bool` - `Type TextEditorCodeExecutionCreateResult` - `const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"` - `type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}` - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` - `Type TextEditorCodeExecutionStrReplaceResult` - `const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"` - `ToolUseID string` - `Type TextEditorCodeExecutionToolResult` - `const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"` - `type BetaToolSearchToolResultBlock struct{…}` - `Content BetaToolSearchToolResultBlockContentUnion` - `type BetaToolSearchToolResultError struct{…}` - `ErrorCode BetaToolSearchToolResultErrorErrorCode` - `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` - `const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"` - `type BetaToolSearchToolSearchResultBlock struct{…}` - `ToolReferences []BetaToolReferenceBlock` - `ToolName string` - `Type ToolReference` - `const ToolReferenceToolReference ToolReference = "tool_reference"` - `Type ToolSearchToolSearchResult` - `const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"` - `ToolUseID string` - `Type ToolSearchToolResult` - `const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"` - `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` - `const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"` - `type BetaMCPToolResultBlock struct{…}` - `Content BetaMCPToolResultBlockContentUnion` - `string` - `type BetaMCPToolResultBlockContentBetaMCPToolResultBlockContent []BetaTextBlock` - `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`. - `Text string` - `Type Text` - `IsError bool` - `ToolUseID string` - `Type MCPToolResult` - `const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"` - `type BetaContainerUploadBlock struct{…}` Response model for a file uploaded to the container. - `FileID string` - `Type ContainerUpload` - `const ContainerUploadContainerUpload ContainerUpload = "container_upload"` - `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 - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `Type Compaction` - `const CompactionCompaction Compaction = "compaction"` - `ContextManagement BetaContextManagementResponse` Context management response. Information about context management strategies applied during the request. - `AppliedEdits []BetaContextManagementResponseAppliedEditUnion` List of context management edits that were applied. - `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. - `const ClearToolUses20250919ClearToolUses20250919 ClearToolUses20250919 = "clear_tool_uses_20250919"` - `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. - `const ClearThinking20251015ClearThinking20251015 ClearThinking20251015 = "clear_thinking_20251015"` - `Diagnostics BetaDiagnostics` Response envelope for request-level diagnostics. Present (possibly null) whenever the caller supplied `diagnostics` on the request. - `CacheMissReason BetaDiagnosticsCacheMissReasonUnion` Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - `type BetaCacheMissModelChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type ModelChanged` - `const ModelChangedModelChanged ModelChanged = "model_changed"` - `type BetaCacheMissSystemChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type SystemChanged` - `const SystemChangedSystemChanged SystemChanged = "system_changed"` - `type BetaCacheMissToolsChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type ToolsChanged` - `const ToolsChangedToolsChanged ToolsChanged = "tools_changed"` - `type BetaCacheMissMessagesChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type MessagesChanged` - `const MessagesChangedMessagesChanged MessagesChanged = "messages_changed"` - `type BetaCacheMissPreviousMessageNotFound struct{…}` - `Type PreviousMessageNotFound` - `const PreviousMessageNotFoundPreviousMessageNotFound PreviousMessageNotFound = "previous_message_not_found"` - `type BetaCacheMissUnavailable struct{…}` - `Type Unavailable` - `const UnavailableUnavailable Unavailable = "unavailable"` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type Model string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `const ModelClaudeOpus4_1 Model = "claude-opus-4-1"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_0 Model = "claude-opus-4-0"` Powerful model for complex tasks - `const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"` Powerful model for complex tasks - `const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"` High-performance model with extended thinking - `const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"` High-performance model with extended thinking - `const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"` Fast and cost-effective model - `string` - `Role Assistant` Conversational role of the generated message. This will always be `"assistant"`. - `const AssistantAssistant Assistant = "assistant"` - `StopDetails BetaRefusalStopDetails` Structured information about a refusal. - `Category BetaRefusalStopDetailsCategory` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `const BetaRefusalStopDetailsCategoryCyber BetaRefusalStopDetailsCategory = "cyber"` - `const BetaRefusalStopDetailsCategoryBio BetaRefusalStopDetailsCategory = "bio"` - `Explanation string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `Type Refusal` - `const RefusalRefusal Refusal = "refusal"` - `StopReason BetaStopReason` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `const BetaStopReasonEndTurn BetaStopReason = "end_turn"` - `const BetaStopReasonMaxTokens BetaStopReason = "max_tokens"` - `const BetaStopReasonStopSequence BetaStopReason = "stop_sequence"` - `const BetaStopReasonToolUse BetaStopReason = "tool_use"` - `const BetaStopReasonPauseTurn BetaStopReason = "pause_turn"` - `const BetaStopReasonCompaction BetaStopReason = "compaction"` - `const BetaStopReasonRefusal BetaStopReason = "refusal"` - `const BetaStopReasonModelContextWindowExceeded BetaStopReason = "model_context_window_exceeded"` - `StopSequence string` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `Type Message` Object type. For Messages, this is always `"message"`. - `const MessageMessage Message = "message"` - `Usage BetaUsage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `CacheCreation 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. - `InferenceGeo string` The geographic region where inference was performed for this request. - `InputTokens int64` The number of input tokens which were used. - `Iterations BetaIterationsUsage` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the true context window size from the last iteration - Understand token accumulation across server-side tool use loops - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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 Message` Usage for a sampling iteration - `const MessageMessage Message = "message"` - `type BetaCompactionIterationUsage struct{…}` Token usage for a compaction iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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 - `const CompactionCompaction Compaction = "compaction"` - `type BetaAdvisorMessageIterationUsage struct{…}` Token usage for an advisor sub-inference iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. - `Type AdvisorMessage` Usage for an advisor sub-inference iteration - `const AdvisorMessageAdvisorMessage AdvisorMessage = "advisor_message"` - `OutputTokens int64` The number of output tokens which were used. - `OutputTokensDetails BetaOutputTokensDetails` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `ThinkingTokens int64` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. - `ServerToolUse BetaServerToolUsage` The number of server tool requests. - `WebFetchRequests int64` The number of web fetch tool requests. - `WebSearchRequests int64` The number of web search tool requests. - `ServiceTier BetaUsageServiceTier` If the request used the priority, standard, or batch tier. - `const BetaUsageServiceTierStandard BetaUsageServiceTier = "standard"` - `const BetaUsageServiceTierPriority BetaUsageServiceTier = "priority"` - `const BetaUsageServiceTierBatch BetaUsageServiceTier = "batch"` - `Speed BetaUsageSpeed` The inference speed mode used for this request. - `const BetaUsageSpeedStandard BetaUsageSpeed = "standard"` - `const BetaUsageSpeedFast BetaUsageSpeed = "fast"` ### Beta Message Delta Usage - `type BetaMessageDeltaUsage struct{…}` - `CacheCreationInputTokens int64` The cumulative number of input tokens used to create the cache entry. - `CacheReadInputTokens int64` The cumulative number of input tokens read from the cache. - `InputTokens int64` The cumulative number of input tokens which were used. - `Iterations BetaIterationsUsage` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the true context window size from the last iteration - Understand token accumulation across server-side tool use loops - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. - `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 Message` Usage for a sampling iteration - `const MessageMessage Message = "message"` - `type BetaCompactionIterationUsage struct{…}` Token usage for a compaction iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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 - `const CompactionCompaction Compaction = "compaction"` - `type BetaAdvisorMessageIterationUsage struct{…}` Token usage for an advisor sub-inference iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type Model string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `const ModelClaudeOpus4_1 Model = "claude-opus-4-1"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_0 Model = "claude-opus-4-0"` Powerful model for complex tasks - `const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"` Powerful model for complex tasks - `const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"` High-performance model with extended thinking - `const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"` High-performance model with extended thinking - `const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"` Fast and cost-effective model - `string` - `OutputTokens int64` The number of output tokens which were used. - `Type AdvisorMessage` Usage for an advisor sub-inference iteration - `const AdvisorMessageAdvisorMessage AdvisorMessage = "advisor_message"` - `OutputTokens int64` The cumulative number of output tokens which were used. - `OutputTokensDetails BetaOutputTokensDetails` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `ThinkingTokens int64` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. - `ServerToolUse BetaServerToolUsage` The number of server tool requests. - `WebFetchRequests int64` The number of web fetch tool requests. - `WebSearchRequests int64` The number of web search tool requests. ### Beta Message Iteration Usage - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. - `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 Message` Usage for a sampling iteration - `const MessageMessage Message = "message"` ### Beta Message Param - `type BetaMessageParamResp struct{…}` - `Content []BetaContentBlockParamUnionResp` - `[]BetaContentBlockParamUnionResp` - `type BetaTextBlockParamResp struct{…}` - `Text string` - `Type Text` - `const TextText Text = "text"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations []BetaTextCitationParamUnionResp` - `type BetaCitationCharLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationWebSearchResultLocationParamResp struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `type BetaImageBlockParamResp struct{…}` - `Source BetaImageBlockParamSourceUnionResp` - `type BetaBase64ImageSource struct{…}` - `Data string` - `MediaType BetaBase64ImageSourceMediaType` - `const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"` - `const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"` - `const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"` - `const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaURLImageSource struct{…}` - `Type URL` - `const URLURL URL = "url"` - `URL string` - `type BetaFileImageSource struct{…}` - `FileID string` - `Type File` - `const FileFile File = "file"` - `Type Image` - `const ImageImage Image = "image"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaRequestDocumentBlock struct{…}` - `Source BetaRequestDocumentBlockSourceUnion` - `type BetaBase64PDFSource struct{…}` - `Data string` - `MediaType ApplicationPDF` - `const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaPlainTextSource struct{…}` - `Data string` - `MediaType TextPlain` - `const TextPlainTextPlain TextPlain = "text/plain"` - `Type Text` - `const TextText Text = "text"` - `type BetaContentBlockSource struct{…}` - `Content BetaContentBlockSourceContentUnion` - `string` - `[]BetaContentBlockSourceContentUnion` - `type BetaTextBlockParamResp struct{…}` - `type BetaImageBlockParamResp struct{…}` - `Type Content` - `const ContentContent Content = "content"` - `type BetaURLPDFSource struct{…}` - `Type URL` - `const URLURL URL = "url"` - `URL string` - `type BetaFileDocumentSource struct{…}` - `FileID string` - `Type File` - `const FileFile File = "file"` - `Type Document` - `const DocumentDocument Document = "document"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` - `Enabled bool` - `Context string` - `Title string` - `type BetaSearchResultBlockParamResp struct{…}` - `Content []BetaTextBlockParamResp` - `Text string` - `Type Text` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnionResp` - `Source string` - `Title string` - `Type SearchResult` - `const SearchResultSearchResult SearchResult = "search_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` - `type BetaThinkingBlockParamResp struct{…}` - `Signature string` - `Thinking string` - `Type Thinking` - `const ThinkingThinking Thinking = "thinking"` - `type BetaRedactedThinkingBlockParamResp struct{…}` - `Data string` - `Type RedactedThinking` - `const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"` - `type BetaToolUseBlockParamResp struct{…}` - `ID string` - `Input map[string, any]` - `Name string` - `Type ToolUse` - `const ToolUseToolUse ToolUse = "tool_use"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Caller BetaToolUseBlockParamCallerUnionResp` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `Type Direct` - `const DirectDirect Direct = "direct"` - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `ToolID string` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `type BetaServerToolCaller20260120 struct{…}` - `ToolID string` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` - `type BetaToolResultBlockParamResp struct{…}` - `ToolUseID string` - `Type ToolResult` - `const ToolResultToolResult ToolResult = "tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Content []BetaToolResultBlockParamContentUnionResp` - `[]BetaToolResultBlockParamContentUnionResp` - `type BetaTextBlockParamResp struct{…}` - `type BetaImageBlockParamResp struct{…}` - `type BetaSearchResultBlockParamResp struct{…}` - `type BetaRequestDocumentBlock struct{…}` - `type BetaToolReferenceBlockParamResp struct{…}` Tool reference block that can be included in tool_result content. - `ToolName string` - `Type ToolReference` - `const ToolReferenceToolReference ToolReference = "tool_reference"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `IsError bool` - `type BetaServerToolUseBlockParamResp struct{…}` - `ID string` - `Input map[string, any]` - `Name BetaServerToolUseBlockParamName` - `const BetaServerToolUseBlockParamNameAdvisor BetaServerToolUseBlockParamName = "advisor"` - `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` - `const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Caller BetaServerToolUseBlockParamCallerUnionResp` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebSearchToolResultBlockParamResp struct{…}` - `Content BetaWebSearchToolResultBlockParamContentUnionResp` - `[]BetaWebSearchResultBlockParamResp` - `EncryptedContent string` - `Title string` - `Type WebSearchResult` - `const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"` - `URL string` - `PageAge string` - `type BetaWebSearchToolRequestError struct{…}` - `ErrorCode BetaWebSearchToolResultErrorCode` - `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` - `const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"` - `ToolUseID string` - `Type WebSearchToolResult` - `const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Caller BetaWebSearchToolResultBlockParamCallerUnionResp` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebFetchToolResultBlockParamResp struct{…}` - `Content BetaWebFetchToolResultBlockParamContentUnionResp` - `type BetaWebFetchToolResultErrorBlockParamResp struct{…}` - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `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` - `const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"` - `type BetaWebFetchBlockParamResp struct{…}` - `Content BetaRequestDocumentBlock` - `Type WebFetchResult` - `const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"` - `URL string` Fetched content URL - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved - `ToolUseID string` - `Type WebFetchToolResult` - `const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Caller BetaWebFetchToolResultBlockParamCallerUnionResp` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaAdvisorToolResultBlockParamResp struct{…}` - `Content BetaAdvisorToolResultBlockParamContentUnionResp` - `type BetaAdvisorToolResultErrorParamResp struct{…}` - `ErrorCode BetaAdvisorToolResultErrorParamErrorCode` - `const BetaAdvisorToolResultErrorParamErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorParamErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorParamErrorCodePromptTooLong BetaAdvisorToolResultErrorParamErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorParamErrorCodeTooManyRequests BetaAdvisorToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorParamErrorCodeOverloaded BetaAdvisorToolResultErrorParamErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorParamErrorCodeUnavailable BetaAdvisorToolResultErrorParamErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorParamErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorParamErrorCode = "execution_time_exceeded"` - `Type AdvisorToolResultError` - `const AdvisorToolResultErrorAdvisorToolResultError AdvisorToolResultError = "advisor_tool_result_error"` - `type BetaAdvisorResultBlockParamResp struct{…}` - `Text string` - `Type AdvisorResult` - `const AdvisorResultAdvisorResult AdvisorResult = "advisor_result"` - `StopReason string` - `type BetaAdvisorRedactedResultBlockParamResp struct{…}` - `EncryptedContent string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `Type AdvisorRedactedResult` - `const AdvisorRedactedResultAdvisorRedactedResult AdvisorRedactedResult = "advisor_redacted_result"` - `StopReason string` - `ToolUseID string` - `Type AdvisorToolResult` - `const AdvisorToolResultAdvisorToolResult AdvisorToolResult = "advisor_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaCodeExecutionToolResultBlockParamResp struct{…}` - `Content BetaCodeExecutionToolResultBlockParamContentUnionResp` Code execution result with encrypted stdout for PFC + web_search results. - `type BetaCodeExecutionToolResultErrorParamResp struct{…}` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `Type CodeExecutionToolResultError` - `const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"` - `type BetaCodeExecutionResultBlockParamResp struct{…}` - `Content []BetaCodeExecutionOutputBlockParamResp` - `FileID string` - `Type CodeExecutionOutput` - `const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type CodeExecutionResult` - `const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"` - `type BetaEncryptedCodeExecutionResultBlockParamResp struct{…}` Code execution result with encrypted stdout for PFC + web_search results. - `Content []BetaCodeExecutionOutputBlockParamResp` - `FileID string` - `Type CodeExecutionOutput` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `Type EncryptedCodeExecutionResult` - `const EncryptedCodeExecutionResultEncryptedCodeExecutionResult EncryptedCodeExecutionResult = "encrypted_code_execution_result"` - `ToolUseID string` - `Type CodeExecutionToolResult` - `const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaBashCodeExecutionToolResultBlockParamResp struct{…}` - `Content BetaBashCodeExecutionToolResultBlockParamContentUnionResp` - `type BetaBashCodeExecutionToolResultErrorParamResp struct{…}` - `ErrorCode BetaBashCodeExecutionToolResultErrorParamErrorCode` - `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` - `const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"` - `type BetaBashCodeExecutionResultBlockParamResp struct{…}` - `Content []BetaBashCodeExecutionOutputBlockParamResp` - `FileID string` - `Type BashCodeExecutionOutput` - `const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type BashCodeExecutionResult` - `const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"` - `ToolUseID string` - `Type BashCodeExecutionToolResult` - `const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaTextEditorCodeExecutionToolResultBlockParamResp struct{…}` - `Content BetaTextEditorCodeExecutionToolResultBlockParamContentUnionResp` - `type BetaTextEditorCodeExecutionToolResultErrorParamResp struct{…}` - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorParamErrorCode` - `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` - `const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"` - `ErrorMessage string` - `type BetaTextEditorCodeExecutionViewResultBlockParamResp struct{…}` - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockParamFileType` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeText BetaTextEditorCodeExecutionViewResultBlockParamFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeImage BetaTextEditorCodeExecutionViewResultBlockParamFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypePDF BetaTextEditorCodeExecutionViewResultBlockParamFileType = "pdf"` - `Type TextEditorCodeExecutionViewResult` - `const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` - `type BetaTextEditorCodeExecutionCreateResultBlockParamResp struct{…}` - `IsFileUpdate bool` - `Type TextEditorCodeExecutionCreateResult` - `const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"` - `type BetaTextEditorCodeExecutionStrReplaceResultBlockParamResp struct{…}` - `Type TextEditorCodeExecutionStrReplaceResult` - `const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"` - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` - `ToolUseID string` - `Type TextEditorCodeExecutionToolResult` - `const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaToolSearchToolResultBlockParamResp struct{…}` - `Content BetaToolSearchToolResultBlockParamContentUnionResp` - `type BetaToolSearchToolResultErrorParamResp struct{…}` - `ErrorCode BetaToolSearchToolResultErrorParamErrorCode` - `const BetaToolSearchToolResultErrorParamErrorCodeInvalidToolInput BetaToolSearchToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaToolSearchToolResultErrorParamErrorCodeUnavailable BetaToolSearchToolResultErrorParamErrorCode = "unavailable"` - `const BetaToolSearchToolResultErrorParamErrorCodeTooManyRequests BetaToolSearchToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaToolSearchToolResultErrorParamErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorParamErrorCode = "execution_time_exceeded"` - `Type ToolSearchToolResultError` - `const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"` - `type BetaToolSearchToolSearchResultBlockParamResp struct{…}` - `ToolReferences []BetaToolReferenceBlockParamResp` - `ToolName string` - `Type ToolReference` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type ToolSearchToolSearchResult` - `const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"` - `ToolUseID string` - `Type ToolSearchToolResult` - `const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaMCPToolUseBlockParamResp struct{…}` - `ID string` - `Input map[string, any]` - `Name string` - `ServerName string` The name of the MCP server - `Type MCPToolUse` - `const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaRequestMCPToolResultBlockParamResp struct{…}` - `ToolUseID string` - `Type MCPToolResult` - `const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Content BetaRequestMCPToolResultBlockParamContentUnionResp` - `string` - `[]BetaTextBlockParamResp` - `Text string` - `Type Text` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnionResp` - `IsError bool` - `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` - `const ContainerUploadContainerUpload ContainerUpload = "container_upload"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `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. - `Type Compaction` - `const CompactionCompaction Compaction = "compaction"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Content string` Summary of previously compacted content, or null if compaction failed - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `type BetaMidConversationSystemBlockParamResp struct{…}` System instructions that appear mid-conversation. Use this block to provide or update system-level instructions at a specific point in the conversation, rather than only via the top-level `system` parameter. - `Content []BetaTextBlockParamResp` System instruction text blocks. - `Text string` - `Type Text` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnionResp` - `Type MidConvSystem` - `const MidConvSystemMidConvSystem MidConvSystem = "mid_conv_system"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Role BetaMessageParamRole` - `const BetaMessageParamRoleUser BetaMessageParamRole = "user"` - `const BetaMessageParamRoleAssistant BetaMessageParamRole = "assistant"` - `const BetaMessageParamRoleSystem BetaMessageParamRole = "system"` ### Beta Message Tokens Count - `type BetaMessageTokensCount struct{…}` - `ContextManagement BetaCountTokensContextManagementResponse` Information about context management applied to the message. - `OriginalInputTokens int64` The original token count before context management was applied - `InputTokens int64` The total number of tokens across the provided list of messages, system prompt, and tools. ### Beta Metadata - `type BetaMetadata struct{…}` - `UserID string` An external identifier for the user who is associated with the request. This should be a uuid, hash value, or other opaque identifier. Anthropic may use this id to help detect abuse. Do not include any identifying information such as name, email address, or phone number. ### Beta Mid Conversation System Block Param - `type BetaMidConversationSystemBlockParamResp struct{…}` System instructions that appear mid-conversation. Use this block to provide or update system-level instructions at a specific point in the conversation, rather than only via the top-level `system` parameter. - `Content []BetaTextBlockParamResp` System instruction text blocks. - `Text string` - `Type Text` - `const TextText Text = "text"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations []BetaTextCitationParamUnionResp` - `type BetaCitationCharLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationWebSearchResultLocationParamResp struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `Type MidConvSystem` - `const MidConvSystemMidConvSystem MidConvSystem = "mid_conv_system"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. ### Beta Output Config - `type BetaOutputConfig struct{…}` - `Effort BetaOutputConfigEffort` All possible effort levels. - `const BetaOutputConfigEffortLow BetaOutputConfigEffort = "low"` - `const BetaOutputConfigEffortMedium BetaOutputConfigEffort = "medium"` - `const BetaOutputConfigEffortHigh BetaOutputConfigEffort = "high"` - `const BetaOutputConfigEffortXhigh BetaOutputConfigEffort = "xhigh"` - `const BetaOutputConfigEffortMax BetaOutputConfigEffort = "max"` - `Format BetaJSONOutputFormat` A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) - `Schema map[string, any]` The JSON schema of the format - `Type JSONSchema` - `const JSONSchemaJSONSchema JSONSchema = "json_schema"` - `TaskBudget BetaTokenTaskBudget` User-configurable total token budget across contexts. - `Total int64` Total token budget across all contexts in the session. - `Type Tokens` The budget type. Currently only 'tokens' is supported. - `const TokensTokens Tokens = "tokens"` - `Remaining int64` Remaining tokens in the budget. Use this to track usage across contexts when implementing compaction client-side. Defaults to total if not provided. ### Beta Output Tokens Details - `type BetaOutputTokensDetails struct{…}` - `ThinkingTokens int64` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. ### Beta Plain Text Source - `type BetaPlainTextSource struct{…}` - `Data string` - `MediaType TextPlain` - `const TextPlainTextPlain TextPlain = "text/plain"` - `Type Text` - `const TextText Text = "text"` ### Beta Raw Content Block Delta - `type BetaRawContentBlockDeltaUnion interface{…}` - `type BetaTextDelta struct{…}` - `Text string` - `Type TextDelta` - `const TextDeltaTextDelta TextDelta = "text_delta"` - `type BetaInputJSONDelta struct{…}` - `PartialJSON string` - `Type InputJSONDelta` - `const InputJSONDeltaInputJSONDelta InputJSONDelta = "input_json_delta"` - `type BetaCitationsDelta struct{…}` - `Citation BetaCitationsDeltaCitationUnion` - `type BetaCitationCharLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationsWebSearchResultLocation struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `Type CitationsDelta` - `const CitationsDeltaCitationsDelta CitationsDelta = "citations_delta"` - `type BetaThinkingDelta struct{…}` - `EstimatedTokens int64` Per-frame increment of a coarse, running estimate of the tokens this thinking block has produced so far. Present whenever the `thinking-token-count-2026-05-13` beta is set; `null` unless `thinking.display` resolves to `"omitted"` and a count is due this frame. Sum the increments across `thinking_delta` frames on this block for a progress indicator. Each increment is a non-negative multiple of a fixed quantum and the cadence is rate-limited, so this is a deliberately lossy display hint, not a billable count; `usage.output_tokens` remains authoritative. - `Thinking string` - `Type ThinkingDelta` - `const ThinkingDeltaThinkingDelta ThinkingDelta = "thinking_delta"` - `type BetaSignatureDelta struct{…}` - `Signature string` - `Type SignatureDelta` - `const SignatureDeltaSignatureDelta SignatureDelta = "signature_delta"` - `type BetaCompactionContentBlockDelta struct{…}` - `Content string` - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `Type CompactionDelta` - `const CompactionDeltaCompactionDelta CompactionDelta = "compaction_delta"` ### Beta Raw Content Block Delta Event - `type BetaRawContentBlockDeltaEvent struct{…}` - `Delta BetaRawContentBlockDeltaUnion` - `type BetaTextDelta struct{…}` - `Text string` - `Type TextDelta` - `const TextDeltaTextDelta TextDelta = "text_delta"` - `type BetaInputJSONDelta struct{…}` - `PartialJSON string` - `Type InputJSONDelta` - `const InputJSONDeltaInputJSONDelta InputJSONDelta = "input_json_delta"` - `type BetaCitationsDelta struct{…}` - `Citation BetaCitationsDeltaCitationUnion` - `type BetaCitationCharLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationsWebSearchResultLocation struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `Type CitationsDelta` - `const CitationsDeltaCitationsDelta CitationsDelta = "citations_delta"` - `type BetaThinkingDelta struct{…}` - `EstimatedTokens int64` Per-frame increment of a coarse, running estimate of the tokens this thinking block has produced so far. Present whenever the `thinking-token-count-2026-05-13` beta is set; `null` unless `thinking.display` resolves to `"omitted"` and a count is due this frame. Sum the increments across `thinking_delta` frames on this block for a progress indicator. Each increment is a non-negative multiple of a fixed quantum and the cadence is rate-limited, so this is a deliberately lossy display hint, not a billable count; `usage.output_tokens` remains authoritative. - `Thinking string` - `Type ThinkingDelta` - `const ThinkingDeltaThinkingDelta ThinkingDelta = "thinking_delta"` - `type BetaSignatureDelta struct{…}` - `Signature string` - `Type SignatureDelta` - `const SignatureDeltaSignatureDelta SignatureDelta = "signature_delta"` - `type BetaCompactionContentBlockDelta struct{…}` - `Content string` - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `Type CompactionDelta` - `const CompactionDeltaCompactionDelta CompactionDelta = "compaction_delta"` - `Index int64` - `Type ContentBlockDelta` - `const ContentBlockDeltaContentBlockDelta ContentBlockDelta = "content_block_delta"` ### Beta Raw Content Block Start Event - `type BetaRawContentBlockStartEvent struct{…}` - `ContentBlock BetaRawContentBlockStartEventContentBlockUnion` Response model for a file uploaded to the container. - `type BetaTextBlock struct{…}` - `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`. - `type BetaCitationCharLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationsWebSearchResultLocation struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `Text string` - `Type Text` - `const TextText Text = "text"` - `type BetaThinkingBlock struct{…}` - `Signature string` - `Thinking string` - `Type Thinking` - `const ThinkingThinking Thinking = "thinking"` - `type BetaRedactedThinkingBlock struct{…}` - `Data string` - `Type RedactedThinking` - `const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"` - `type BetaToolUseBlock struct{…}` - `ID string` - `Input map[string, any]` - `Name string` - `Type ToolUse` - `const ToolUseToolUse ToolUse = "tool_use"` - `Caller BetaToolUseBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `Type Direct` - `const DirectDirect Direct = "direct"` - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `ToolID string` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `type BetaServerToolCaller20260120 struct{…}` - `ToolID string` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` - `type BetaServerToolUseBlock struct{…}` - `ID string` - `Input map[string, any]` - `Name BetaServerToolUseBlockName` - `const BetaServerToolUseBlockNameAdvisor BetaServerToolUseBlockName = "advisor"` - `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` - `const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"` - `Caller BetaServerToolUseBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebSearchToolResultBlock struct{…}` - `Content BetaWebSearchToolResultBlockContentUnion` - `type BetaWebSearchToolResultError struct{…}` - `ErrorCode BetaWebSearchToolResultErrorCode` - `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` - `const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"` - `type BetaWebSearchToolResultBlockContentArray []BetaWebSearchResultBlock` - `EncryptedContent string` - `PageAge string` - `Title string` - `Type WebSearchResult` - `const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"` - `URL string` - `ToolUseID string` - `Type WebSearchToolResult` - `const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"` - `Caller BetaWebSearchToolResultBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebFetchToolResultBlock struct{…}` - `Content BetaWebFetchToolResultBlockContentUnion` - `type BetaWebFetchToolResultErrorBlock struct{…}` - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `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` - `const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"` - `type BetaWebFetchBlock struct{…}` - `Content BetaDocumentBlock` - `Citations BetaCitationConfig` Citation configuration for the document - `Enabled bool` - `Source BetaDocumentBlockSourceUnion` - `type BetaBase64PDFSource struct{…}` - `Data string` - `MediaType ApplicationPDF` - `const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaPlainTextSource struct{…}` - `Data string` - `MediaType TextPlain` - `const TextPlainTextPlain TextPlain = "text/plain"` - `Type Text` - `const TextText Text = "text"` - `Title string` The title of the document - `Type Document` - `const DocumentDocument Document = "document"` - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved - `Type WebFetchResult` - `const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"` - `URL string` Fetched content URL - `ToolUseID string` - `Type WebFetchToolResult` - `const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"` - `Caller BetaWebFetchToolResultBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaAdvisorToolResultBlock struct{…}` - `Content BetaAdvisorToolResultBlockContentUnion` - `type BetaAdvisorToolResultError struct{…}` - `ErrorCode BetaAdvisorToolResultErrorErrorCode` - `const BetaAdvisorToolResultErrorErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodePromptTooLong BetaAdvisorToolResultErrorErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorErrorCodeTooManyRequests BetaAdvisorToolResultErrorErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorErrorCodeOverloaded BetaAdvisorToolResultErrorErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorErrorCodeUnavailable BetaAdvisorToolResultErrorErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorErrorCode = "execution_time_exceeded"` - `Type AdvisorToolResultError` - `const AdvisorToolResultErrorAdvisorToolResultError AdvisorToolResultError = "advisor_tool_result_error"` - `type BetaAdvisorResultBlock struct{…}` - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `Text string` - `Type AdvisorResult` - `const AdvisorResultAdvisorResult AdvisorResult = "advisor_result"` - `type BetaAdvisorRedactedResultBlock struct{…}` - `EncryptedContent string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `Type AdvisorRedactedResult` - `const AdvisorRedactedResultAdvisorRedactedResult AdvisorRedactedResult = "advisor_redacted_result"` - `ToolUseID string` - `Type AdvisorToolResult` - `const AdvisorToolResultAdvisorToolResult AdvisorToolResult = "advisor_tool_result"` - `type BetaCodeExecutionToolResultBlock struct{…}` - `Content BetaCodeExecutionToolResultBlockContentUnion` Code execution result with encrypted stdout for PFC + web_search results. - `type BetaCodeExecutionToolResultError struct{…}` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `Type CodeExecutionToolResultError` - `const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"` - `type BetaCodeExecutionResultBlock struct{…}` - `Content []BetaCodeExecutionOutputBlock` - `FileID string` - `Type CodeExecutionOutput` - `const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type CodeExecutionResult` - `const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"` - `type BetaEncryptedCodeExecutionResultBlock struct{…}` Code execution result with encrypted stdout for PFC + web_search results. - `Content []BetaCodeExecutionOutputBlock` - `FileID string` - `Type CodeExecutionOutput` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `Type EncryptedCodeExecutionResult` - `const EncryptedCodeExecutionResultEncryptedCodeExecutionResult EncryptedCodeExecutionResult = "encrypted_code_execution_result"` - `ToolUseID string` - `Type CodeExecutionToolResult` - `const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"` - `type BetaBashCodeExecutionToolResultBlock struct{…}` - `Content BetaBashCodeExecutionToolResultBlockContentUnion` - `type BetaBashCodeExecutionToolResultError struct{…}` - `ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode` - `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` - `const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"` - `type BetaBashCodeExecutionResultBlock struct{…}` - `Content []BetaBashCodeExecutionOutputBlock` - `FileID string` - `Type BashCodeExecutionOutput` - `const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type BashCodeExecutionResult` - `const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"` - `ToolUseID string` - `Type BashCodeExecutionToolResult` - `const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"` - `type BetaTextEditorCodeExecutionToolResultBlock struct{…}` - `Content BetaTextEditorCodeExecutionToolResultBlockContentUnion` - `type BetaTextEditorCodeExecutionToolResultError struct{…}` - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode` - `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` - `const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"` - `type BetaTextEditorCodeExecutionViewResultBlock struct{…}` - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockFileType` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` - `Type TextEditorCodeExecutionViewResult` - `const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"` - `type BetaTextEditorCodeExecutionCreateResultBlock struct{…}` - `IsFileUpdate bool` - `Type TextEditorCodeExecutionCreateResult` - `const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"` - `type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}` - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` - `Type TextEditorCodeExecutionStrReplaceResult` - `const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"` - `ToolUseID string` - `Type TextEditorCodeExecutionToolResult` - `const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"` - `type BetaToolSearchToolResultBlock struct{…}` - `Content BetaToolSearchToolResultBlockContentUnion` - `type BetaToolSearchToolResultError struct{…}` - `ErrorCode BetaToolSearchToolResultErrorErrorCode` - `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` - `const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"` - `type BetaToolSearchToolSearchResultBlock struct{…}` - `ToolReferences []BetaToolReferenceBlock` - `ToolName string` - `Type ToolReference` - `const ToolReferenceToolReference ToolReference = "tool_reference"` - `Type ToolSearchToolSearchResult` - `const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"` - `ToolUseID string` - `Type ToolSearchToolResult` - `const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"` - `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` - `const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"` - `type BetaMCPToolResultBlock struct{…}` - `Content BetaMCPToolResultBlockContentUnion` - `string` - `type BetaMCPToolResultBlockContentBetaMCPToolResultBlockContent []BetaTextBlock` - `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`. - `Text string` - `Type Text` - `IsError bool` - `ToolUseID string` - `Type MCPToolResult` - `const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"` - `type BetaContainerUploadBlock struct{…}` Response model for a file uploaded to the container. - `FileID string` - `Type ContainerUpload` - `const ContainerUploadContainerUpload ContainerUpload = "container_upload"` - `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 - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `Type Compaction` - `const CompactionCompaction Compaction = "compaction"` - `Index int64` - `Type ContentBlockStart` - `const ContentBlockStartContentBlockStart ContentBlockStart = "content_block_start"` ### Beta Raw Content Block Stop Event - `type BetaRawContentBlockStopEvent struct{…}` - `Index int64` - `Type ContentBlockStop` - `const ContentBlockStopContentBlockStop ContentBlockStop = "content_block_stop"` ### Beta Raw Message Delta Event - `type BetaRawMessageDeltaEvent struct{…}` - `ContextManagement BetaContextManagementResponse` Information about context management strategies applied during the request - `AppliedEdits []BetaContextManagementResponseAppliedEditUnion` List of context management edits that were applied. - `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. - `const ClearToolUses20250919ClearToolUses20250919 ClearToolUses20250919 = "clear_tool_uses_20250919"` - `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. - `const ClearThinking20251015ClearThinking20251015 ClearThinking20251015 = "clear_thinking_20251015"` - `Delta BetaRawMessageDeltaEventDelta` - `Container BetaContainer` Information about the container used in the request (for the code execution tool) - `ID string` Identifier for the container used in this request - `ExpiresAt Time` The time at which the container will expire. - `Skills []BetaSkill` Skills loaded in the container - `SkillID string` Skill ID - `Type BetaSkillType` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `const BetaSkillTypeAnthropic BetaSkillType = "anthropic"` - `const BetaSkillTypeCustom BetaSkillType = "custom"` - `Version string` Skill version or 'latest' for most recent version - `StopDetails BetaRefusalStopDetails` Structured information about a refusal. - `Category BetaRefusalStopDetailsCategory` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `const BetaRefusalStopDetailsCategoryCyber BetaRefusalStopDetailsCategory = "cyber"` - `const BetaRefusalStopDetailsCategoryBio BetaRefusalStopDetailsCategory = "bio"` - `Explanation string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `Type Refusal` - `const RefusalRefusal Refusal = "refusal"` - `StopReason BetaStopReason` - `const BetaStopReasonEndTurn BetaStopReason = "end_turn"` - `const BetaStopReasonMaxTokens BetaStopReason = "max_tokens"` - `const BetaStopReasonStopSequence BetaStopReason = "stop_sequence"` - `const BetaStopReasonToolUse BetaStopReason = "tool_use"` - `const BetaStopReasonPauseTurn BetaStopReason = "pause_turn"` - `const BetaStopReasonCompaction BetaStopReason = "compaction"` - `const BetaStopReasonRefusal BetaStopReason = "refusal"` - `const BetaStopReasonModelContextWindowExceeded BetaStopReason = "model_context_window_exceeded"` - `StopSequence string` - `Type MessageDelta` - `const MessageDeltaMessageDelta MessageDelta = "message_delta"` - `Usage BetaMessageDeltaUsage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `CacheCreationInputTokens int64` The cumulative number of input tokens used to create the cache entry. - `CacheReadInputTokens int64` The cumulative number of input tokens read from the cache. - `InputTokens int64` The cumulative number of input tokens which were used. - `Iterations BetaIterationsUsage` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the true context window size from the last iteration - Understand token accumulation across server-side tool use loops - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. - `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 Message` Usage for a sampling iteration - `const MessageMessage Message = "message"` - `type BetaCompactionIterationUsage struct{…}` Token usage for a compaction iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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 - `const CompactionCompaction Compaction = "compaction"` - `type BetaAdvisorMessageIterationUsage struct{…}` Token usage for an advisor sub-inference iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type Model string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `const ModelClaudeOpus4_1 Model = "claude-opus-4-1"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_0 Model = "claude-opus-4-0"` Powerful model for complex tasks - `const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"` Powerful model for complex tasks - `const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"` High-performance model with extended thinking - `const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"` High-performance model with extended thinking - `const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"` Fast and cost-effective model - `string` - `OutputTokens int64` The number of output tokens which were used. - `Type AdvisorMessage` Usage for an advisor sub-inference iteration - `const AdvisorMessageAdvisorMessage AdvisorMessage = "advisor_message"` - `OutputTokens int64` The cumulative number of output tokens which were used. - `OutputTokensDetails BetaOutputTokensDetails` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `ThinkingTokens int64` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. - `ServerToolUse BetaServerToolUsage` The number of server tool requests. - `WebFetchRequests int64` The number of web fetch tool requests. - `WebSearchRequests int64` The number of web search tool requests. ### Beta Raw Message Start Event - `type BetaRawMessageStartEvent struct{…}` - `Message BetaMessage` - `ID string` Unique object identifier. The format and length of IDs may change over time. - `Container BetaContainer` Information about the container used in the request (for the code execution tool) - `ID string` Identifier for the container used in this request - `ExpiresAt Time` The time at which the container will expire. - `Skills []BetaSkill` Skills loaded in the container - `SkillID string` Skill ID - `Type BetaSkillType` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `const BetaSkillTypeAnthropic BetaSkillType = "anthropic"` - `const BetaSkillTypeCustom BetaSkillType = "custom"` - `Version string` Skill version or 'latest' for most recent version - `Content []BetaContentBlockUnion` Content generated by the model. This is an array of content blocks, each of which has a `type` that determines its shape. Example: ```json [{"type": "text", "text": "Hi, I'm Claude."}] ``` If the request input `messages` ended with an `assistant` turn, then the response `content` will continue directly from that last turn. You can use this to constrain the model's output. For example, if the input `messages` were: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("} ] ``` Then the response `content` might be: ```json [{"type": "text", "text": "B)"}] ``` - `type BetaTextBlock struct{…}` - `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`. - `type BetaCitationCharLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationsWebSearchResultLocation struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `Text string` - `Type Text` - `const TextText Text = "text"` - `type BetaThinkingBlock struct{…}` - `Signature string` - `Thinking string` - `Type Thinking` - `const ThinkingThinking Thinking = "thinking"` - `type BetaRedactedThinkingBlock struct{…}` - `Data string` - `Type RedactedThinking` - `const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"` - `type BetaToolUseBlock struct{…}` - `ID string` - `Input map[string, any]` - `Name string` - `Type ToolUse` - `const ToolUseToolUse ToolUse = "tool_use"` - `Caller BetaToolUseBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `Type Direct` - `const DirectDirect Direct = "direct"` - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `ToolID string` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `type BetaServerToolCaller20260120 struct{…}` - `ToolID string` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` - `type BetaServerToolUseBlock struct{…}` - `ID string` - `Input map[string, any]` - `Name BetaServerToolUseBlockName` - `const BetaServerToolUseBlockNameAdvisor BetaServerToolUseBlockName = "advisor"` - `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` - `const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"` - `Caller BetaServerToolUseBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebSearchToolResultBlock struct{…}` - `Content BetaWebSearchToolResultBlockContentUnion` - `type BetaWebSearchToolResultError struct{…}` - `ErrorCode BetaWebSearchToolResultErrorCode` - `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` - `const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"` - `type BetaWebSearchToolResultBlockContentArray []BetaWebSearchResultBlock` - `EncryptedContent string` - `PageAge string` - `Title string` - `Type WebSearchResult` - `const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"` - `URL string` - `ToolUseID string` - `Type WebSearchToolResult` - `const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"` - `Caller BetaWebSearchToolResultBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebFetchToolResultBlock struct{…}` - `Content BetaWebFetchToolResultBlockContentUnion` - `type BetaWebFetchToolResultErrorBlock struct{…}` - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `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` - `const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"` - `type BetaWebFetchBlock struct{…}` - `Content BetaDocumentBlock` - `Citations BetaCitationConfig` Citation configuration for the document - `Enabled bool` - `Source BetaDocumentBlockSourceUnion` - `type BetaBase64PDFSource struct{…}` - `Data string` - `MediaType ApplicationPDF` - `const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaPlainTextSource struct{…}` - `Data string` - `MediaType TextPlain` - `const TextPlainTextPlain TextPlain = "text/plain"` - `Type Text` - `const TextText Text = "text"` - `Title string` The title of the document - `Type Document` - `const DocumentDocument Document = "document"` - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved - `Type WebFetchResult` - `const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"` - `URL string` Fetched content URL - `ToolUseID string` - `Type WebFetchToolResult` - `const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"` - `Caller BetaWebFetchToolResultBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaAdvisorToolResultBlock struct{…}` - `Content BetaAdvisorToolResultBlockContentUnion` - `type BetaAdvisorToolResultError struct{…}` - `ErrorCode BetaAdvisorToolResultErrorErrorCode` - `const BetaAdvisorToolResultErrorErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodePromptTooLong BetaAdvisorToolResultErrorErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorErrorCodeTooManyRequests BetaAdvisorToolResultErrorErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorErrorCodeOverloaded BetaAdvisorToolResultErrorErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorErrorCodeUnavailable BetaAdvisorToolResultErrorErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorErrorCode = "execution_time_exceeded"` - `Type AdvisorToolResultError` - `const AdvisorToolResultErrorAdvisorToolResultError AdvisorToolResultError = "advisor_tool_result_error"` - `type BetaAdvisorResultBlock struct{…}` - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `Text string` - `Type AdvisorResult` - `const AdvisorResultAdvisorResult AdvisorResult = "advisor_result"` - `type BetaAdvisorRedactedResultBlock struct{…}` - `EncryptedContent string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `Type AdvisorRedactedResult` - `const AdvisorRedactedResultAdvisorRedactedResult AdvisorRedactedResult = "advisor_redacted_result"` - `ToolUseID string` - `Type AdvisorToolResult` - `const AdvisorToolResultAdvisorToolResult AdvisorToolResult = "advisor_tool_result"` - `type BetaCodeExecutionToolResultBlock struct{…}` - `Content BetaCodeExecutionToolResultBlockContentUnion` Code execution result with encrypted stdout for PFC + web_search results. - `type BetaCodeExecutionToolResultError struct{…}` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `Type CodeExecutionToolResultError` - `const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"` - `type BetaCodeExecutionResultBlock struct{…}` - `Content []BetaCodeExecutionOutputBlock` - `FileID string` - `Type CodeExecutionOutput` - `const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type CodeExecutionResult` - `const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"` - `type BetaEncryptedCodeExecutionResultBlock struct{…}` Code execution result with encrypted stdout for PFC + web_search results. - `Content []BetaCodeExecutionOutputBlock` - `FileID string` - `Type CodeExecutionOutput` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `Type EncryptedCodeExecutionResult` - `const EncryptedCodeExecutionResultEncryptedCodeExecutionResult EncryptedCodeExecutionResult = "encrypted_code_execution_result"` - `ToolUseID string` - `Type CodeExecutionToolResult` - `const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"` - `type BetaBashCodeExecutionToolResultBlock struct{…}` - `Content BetaBashCodeExecutionToolResultBlockContentUnion` - `type BetaBashCodeExecutionToolResultError struct{…}` - `ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode` - `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` - `const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"` - `type BetaBashCodeExecutionResultBlock struct{…}` - `Content []BetaBashCodeExecutionOutputBlock` - `FileID string` - `Type BashCodeExecutionOutput` - `const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type BashCodeExecutionResult` - `const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"` - `ToolUseID string` - `Type BashCodeExecutionToolResult` - `const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"` - `type BetaTextEditorCodeExecutionToolResultBlock struct{…}` - `Content BetaTextEditorCodeExecutionToolResultBlockContentUnion` - `type BetaTextEditorCodeExecutionToolResultError struct{…}` - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode` - `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` - `const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"` - `type BetaTextEditorCodeExecutionViewResultBlock struct{…}` - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockFileType` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` - `Type TextEditorCodeExecutionViewResult` - `const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"` - `type BetaTextEditorCodeExecutionCreateResultBlock struct{…}` - `IsFileUpdate bool` - `Type TextEditorCodeExecutionCreateResult` - `const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"` - `type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}` - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` - `Type TextEditorCodeExecutionStrReplaceResult` - `const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"` - `ToolUseID string` - `Type TextEditorCodeExecutionToolResult` - `const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"` - `type BetaToolSearchToolResultBlock struct{…}` - `Content BetaToolSearchToolResultBlockContentUnion` - `type BetaToolSearchToolResultError struct{…}` - `ErrorCode BetaToolSearchToolResultErrorErrorCode` - `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` - `const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"` - `type BetaToolSearchToolSearchResultBlock struct{…}` - `ToolReferences []BetaToolReferenceBlock` - `ToolName string` - `Type ToolReference` - `const ToolReferenceToolReference ToolReference = "tool_reference"` - `Type ToolSearchToolSearchResult` - `const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"` - `ToolUseID string` - `Type ToolSearchToolResult` - `const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"` - `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` - `const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"` - `type BetaMCPToolResultBlock struct{…}` - `Content BetaMCPToolResultBlockContentUnion` - `string` - `type BetaMCPToolResultBlockContentBetaMCPToolResultBlockContent []BetaTextBlock` - `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`. - `Text string` - `Type Text` - `IsError bool` - `ToolUseID string` - `Type MCPToolResult` - `const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"` - `type BetaContainerUploadBlock struct{…}` Response model for a file uploaded to the container. - `FileID string` - `Type ContainerUpload` - `const ContainerUploadContainerUpload ContainerUpload = "container_upload"` - `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 - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `Type Compaction` - `const CompactionCompaction Compaction = "compaction"` - `ContextManagement BetaContextManagementResponse` Context management response. Information about context management strategies applied during the request. - `AppliedEdits []BetaContextManagementResponseAppliedEditUnion` List of context management edits that were applied. - `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. - `const ClearToolUses20250919ClearToolUses20250919 ClearToolUses20250919 = "clear_tool_uses_20250919"` - `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. - `const ClearThinking20251015ClearThinking20251015 ClearThinking20251015 = "clear_thinking_20251015"` - `Diagnostics BetaDiagnostics` Response envelope for request-level diagnostics. Present (possibly null) whenever the caller supplied `diagnostics` on the request. - `CacheMissReason BetaDiagnosticsCacheMissReasonUnion` Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - `type BetaCacheMissModelChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type ModelChanged` - `const ModelChangedModelChanged ModelChanged = "model_changed"` - `type BetaCacheMissSystemChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type SystemChanged` - `const SystemChangedSystemChanged SystemChanged = "system_changed"` - `type BetaCacheMissToolsChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type ToolsChanged` - `const ToolsChangedToolsChanged ToolsChanged = "tools_changed"` - `type BetaCacheMissMessagesChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type MessagesChanged` - `const MessagesChangedMessagesChanged MessagesChanged = "messages_changed"` - `type BetaCacheMissPreviousMessageNotFound struct{…}` - `Type PreviousMessageNotFound` - `const PreviousMessageNotFoundPreviousMessageNotFound PreviousMessageNotFound = "previous_message_not_found"` - `type BetaCacheMissUnavailable struct{…}` - `Type Unavailable` - `const UnavailableUnavailable Unavailable = "unavailable"` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type Model string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `const ModelClaudeOpus4_1 Model = "claude-opus-4-1"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_0 Model = "claude-opus-4-0"` Powerful model for complex tasks - `const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"` Powerful model for complex tasks - `const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"` High-performance model with extended thinking - `const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"` High-performance model with extended thinking - `const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"` Fast and cost-effective model - `string` - `Role Assistant` Conversational role of the generated message. This will always be `"assistant"`. - `const AssistantAssistant Assistant = "assistant"` - `StopDetails BetaRefusalStopDetails` Structured information about a refusal. - `Category BetaRefusalStopDetailsCategory` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `const BetaRefusalStopDetailsCategoryCyber BetaRefusalStopDetailsCategory = "cyber"` - `const BetaRefusalStopDetailsCategoryBio BetaRefusalStopDetailsCategory = "bio"` - `Explanation string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `Type Refusal` - `const RefusalRefusal Refusal = "refusal"` - `StopReason BetaStopReason` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `const BetaStopReasonEndTurn BetaStopReason = "end_turn"` - `const BetaStopReasonMaxTokens BetaStopReason = "max_tokens"` - `const BetaStopReasonStopSequence BetaStopReason = "stop_sequence"` - `const BetaStopReasonToolUse BetaStopReason = "tool_use"` - `const BetaStopReasonPauseTurn BetaStopReason = "pause_turn"` - `const BetaStopReasonCompaction BetaStopReason = "compaction"` - `const BetaStopReasonRefusal BetaStopReason = "refusal"` - `const BetaStopReasonModelContextWindowExceeded BetaStopReason = "model_context_window_exceeded"` - `StopSequence string` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `Type Message` Object type. For Messages, this is always `"message"`. - `const MessageMessage Message = "message"` - `Usage BetaUsage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `CacheCreation 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. - `InferenceGeo string` The geographic region where inference was performed for this request. - `InputTokens int64` The number of input tokens which were used. - `Iterations BetaIterationsUsage` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the true context window size from the last iteration - Understand token accumulation across server-side tool use loops - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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 Message` Usage for a sampling iteration - `const MessageMessage Message = "message"` - `type BetaCompactionIterationUsage struct{…}` Token usage for a compaction iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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 - `const CompactionCompaction Compaction = "compaction"` - `type BetaAdvisorMessageIterationUsage struct{…}` Token usage for an advisor sub-inference iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. - `Type AdvisorMessage` Usage for an advisor sub-inference iteration - `const AdvisorMessageAdvisorMessage AdvisorMessage = "advisor_message"` - `OutputTokens int64` The number of output tokens which were used. - `OutputTokensDetails BetaOutputTokensDetails` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `ThinkingTokens int64` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. - `ServerToolUse BetaServerToolUsage` The number of server tool requests. - `WebFetchRequests int64` The number of web fetch tool requests. - `WebSearchRequests int64` The number of web search tool requests. - `ServiceTier BetaUsageServiceTier` If the request used the priority, standard, or batch tier. - `const BetaUsageServiceTierStandard BetaUsageServiceTier = "standard"` - `const BetaUsageServiceTierPriority BetaUsageServiceTier = "priority"` - `const BetaUsageServiceTierBatch BetaUsageServiceTier = "batch"` - `Speed BetaUsageSpeed` The inference speed mode used for this request. - `const BetaUsageSpeedStandard BetaUsageSpeed = "standard"` - `const BetaUsageSpeedFast BetaUsageSpeed = "fast"` - `Type MessageStart` - `const MessageStartMessageStart MessageStart = "message_start"` ### Beta Raw Message Stop Event - `type BetaRawMessageStopEvent struct{…}` - `Type MessageStop` - `const MessageStopMessageStop MessageStop = "message_stop"` ### Beta Raw Message Stream Event - `type BetaRawMessageStreamEventUnion interface{…}` - `type BetaRawMessageStartEvent struct{…}` - `Message BetaMessage` - `ID string` Unique object identifier. The format and length of IDs may change over time. - `Container BetaContainer` Information about the container used in the request (for the code execution tool) - `ID string` Identifier for the container used in this request - `ExpiresAt Time` The time at which the container will expire. - `Skills []BetaSkill` Skills loaded in the container - `SkillID string` Skill ID - `Type BetaSkillType` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `const BetaSkillTypeAnthropic BetaSkillType = "anthropic"` - `const BetaSkillTypeCustom BetaSkillType = "custom"` - `Version string` Skill version or 'latest' for most recent version - `Content []BetaContentBlockUnion` Content generated by the model. This is an array of content blocks, each of which has a `type` that determines its shape. Example: ```json [{"type": "text", "text": "Hi, I'm Claude."}] ``` If the request input `messages` ended with an `assistant` turn, then the response `content` will continue directly from that last turn. You can use this to constrain the model's output. For example, if the input `messages` were: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("} ] ``` Then the response `content` might be: ```json [{"type": "text", "text": "B)"}] ``` - `type BetaTextBlock struct{…}` - `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`. - `type BetaCitationCharLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationsWebSearchResultLocation struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `Text string` - `Type Text` - `const TextText Text = "text"` - `type BetaThinkingBlock struct{…}` - `Signature string` - `Thinking string` - `Type Thinking` - `const ThinkingThinking Thinking = "thinking"` - `type BetaRedactedThinkingBlock struct{…}` - `Data string` - `Type RedactedThinking` - `const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"` - `type BetaToolUseBlock struct{…}` - `ID string` - `Input map[string, any]` - `Name string` - `Type ToolUse` - `const ToolUseToolUse ToolUse = "tool_use"` - `Caller BetaToolUseBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `Type Direct` - `const DirectDirect Direct = "direct"` - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `ToolID string` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `type BetaServerToolCaller20260120 struct{…}` - `ToolID string` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` - `type BetaServerToolUseBlock struct{…}` - `ID string` - `Input map[string, any]` - `Name BetaServerToolUseBlockName` - `const BetaServerToolUseBlockNameAdvisor BetaServerToolUseBlockName = "advisor"` - `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` - `const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"` - `Caller BetaServerToolUseBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebSearchToolResultBlock struct{…}` - `Content BetaWebSearchToolResultBlockContentUnion` - `type BetaWebSearchToolResultError struct{…}` - `ErrorCode BetaWebSearchToolResultErrorCode` - `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` - `const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"` - `type BetaWebSearchToolResultBlockContentArray []BetaWebSearchResultBlock` - `EncryptedContent string` - `PageAge string` - `Title string` - `Type WebSearchResult` - `const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"` - `URL string` - `ToolUseID string` - `Type WebSearchToolResult` - `const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"` - `Caller BetaWebSearchToolResultBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebFetchToolResultBlock struct{…}` - `Content BetaWebFetchToolResultBlockContentUnion` - `type BetaWebFetchToolResultErrorBlock struct{…}` - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `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` - `const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"` - `type BetaWebFetchBlock struct{…}` - `Content BetaDocumentBlock` - `Citations BetaCitationConfig` Citation configuration for the document - `Enabled bool` - `Source BetaDocumentBlockSourceUnion` - `type BetaBase64PDFSource struct{…}` - `Data string` - `MediaType ApplicationPDF` - `const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaPlainTextSource struct{…}` - `Data string` - `MediaType TextPlain` - `const TextPlainTextPlain TextPlain = "text/plain"` - `Type Text` - `const TextText Text = "text"` - `Title string` The title of the document - `Type Document` - `const DocumentDocument Document = "document"` - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved - `Type WebFetchResult` - `const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"` - `URL string` Fetched content URL - `ToolUseID string` - `Type WebFetchToolResult` - `const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"` - `Caller BetaWebFetchToolResultBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaAdvisorToolResultBlock struct{…}` - `Content BetaAdvisorToolResultBlockContentUnion` - `type BetaAdvisorToolResultError struct{…}` - `ErrorCode BetaAdvisorToolResultErrorErrorCode` - `const BetaAdvisorToolResultErrorErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodePromptTooLong BetaAdvisorToolResultErrorErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorErrorCodeTooManyRequests BetaAdvisorToolResultErrorErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorErrorCodeOverloaded BetaAdvisorToolResultErrorErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorErrorCodeUnavailable BetaAdvisorToolResultErrorErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorErrorCode = "execution_time_exceeded"` - `Type AdvisorToolResultError` - `const AdvisorToolResultErrorAdvisorToolResultError AdvisorToolResultError = "advisor_tool_result_error"` - `type BetaAdvisorResultBlock struct{…}` - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `Text string` - `Type AdvisorResult` - `const AdvisorResultAdvisorResult AdvisorResult = "advisor_result"` - `type BetaAdvisorRedactedResultBlock struct{…}` - `EncryptedContent string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `Type AdvisorRedactedResult` - `const AdvisorRedactedResultAdvisorRedactedResult AdvisorRedactedResult = "advisor_redacted_result"` - `ToolUseID string` - `Type AdvisorToolResult` - `const AdvisorToolResultAdvisorToolResult AdvisorToolResult = "advisor_tool_result"` - `type BetaCodeExecutionToolResultBlock struct{…}` - `Content BetaCodeExecutionToolResultBlockContentUnion` Code execution result with encrypted stdout for PFC + web_search results. - `type BetaCodeExecutionToolResultError struct{…}` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `Type CodeExecutionToolResultError` - `const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"` - `type BetaCodeExecutionResultBlock struct{…}` - `Content []BetaCodeExecutionOutputBlock` - `FileID string` - `Type CodeExecutionOutput` - `const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type CodeExecutionResult` - `const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"` - `type BetaEncryptedCodeExecutionResultBlock struct{…}` Code execution result with encrypted stdout for PFC + web_search results. - `Content []BetaCodeExecutionOutputBlock` - `FileID string` - `Type CodeExecutionOutput` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `Type EncryptedCodeExecutionResult` - `const EncryptedCodeExecutionResultEncryptedCodeExecutionResult EncryptedCodeExecutionResult = "encrypted_code_execution_result"` - `ToolUseID string` - `Type CodeExecutionToolResult` - `const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"` - `type BetaBashCodeExecutionToolResultBlock struct{…}` - `Content BetaBashCodeExecutionToolResultBlockContentUnion` - `type BetaBashCodeExecutionToolResultError struct{…}` - `ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode` - `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` - `const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"` - `type BetaBashCodeExecutionResultBlock struct{…}` - `Content []BetaBashCodeExecutionOutputBlock` - `FileID string` - `Type BashCodeExecutionOutput` - `const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type BashCodeExecutionResult` - `const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"` - `ToolUseID string` - `Type BashCodeExecutionToolResult` - `const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"` - `type BetaTextEditorCodeExecutionToolResultBlock struct{…}` - `Content BetaTextEditorCodeExecutionToolResultBlockContentUnion` - `type BetaTextEditorCodeExecutionToolResultError struct{…}` - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode` - `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` - `const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"` - `type BetaTextEditorCodeExecutionViewResultBlock struct{…}` - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockFileType` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` - `Type TextEditorCodeExecutionViewResult` - `const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"` - `type BetaTextEditorCodeExecutionCreateResultBlock struct{…}` - `IsFileUpdate bool` - `Type TextEditorCodeExecutionCreateResult` - `const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"` - `type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}` - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` - `Type TextEditorCodeExecutionStrReplaceResult` - `const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"` - `ToolUseID string` - `Type TextEditorCodeExecutionToolResult` - `const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"` - `type BetaToolSearchToolResultBlock struct{…}` - `Content BetaToolSearchToolResultBlockContentUnion` - `type BetaToolSearchToolResultError struct{…}` - `ErrorCode BetaToolSearchToolResultErrorErrorCode` - `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` - `const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"` - `type BetaToolSearchToolSearchResultBlock struct{…}` - `ToolReferences []BetaToolReferenceBlock` - `ToolName string` - `Type ToolReference` - `const ToolReferenceToolReference ToolReference = "tool_reference"` - `Type ToolSearchToolSearchResult` - `const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"` - `ToolUseID string` - `Type ToolSearchToolResult` - `const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"` - `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` - `const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"` - `type BetaMCPToolResultBlock struct{…}` - `Content BetaMCPToolResultBlockContentUnion` - `string` - `type BetaMCPToolResultBlockContentBetaMCPToolResultBlockContent []BetaTextBlock` - `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`. - `Text string` - `Type Text` - `IsError bool` - `ToolUseID string` - `Type MCPToolResult` - `const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"` - `type BetaContainerUploadBlock struct{…}` Response model for a file uploaded to the container. - `FileID string` - `Type ContainerUpload` - `const ContainerUploadContainerUpload ContainerUpload = "container_upload"` - `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 - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `Type Compaction` - `const CompactionCompaction Compaction = "compaction"` - `ContextManagement BetaContextManagementResponse` Context management response. Information about context management strategies applied during the request. - `AppliedEdits []BetaContextManagementResponseAppliedEditUnion` List of context management edits that were applied. - `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. - `const ClearToolUses20250919ClearToolUses20250919 ClearToolUses20250919 = "clear_tool_uses_20250919"` - `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. - `const ClearThinking20251015ClearThinking20251015 ClearThinking20251015 = "clear_thinking_20251015"` - `Diagnostics BetaDiagnostics` Response envelope for request-level diagnostics. Present (possibly null) whenever the caller supplied `diagnostics` on the request. - `CacheMissReason BetaDiagnosticsCacheMissReasonUnion` Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - `type BetaCacheMissModelChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type ModelChanged` - `const ModelChangedModelChanged ModelChanged = "model_changed"` - `type BetaCacheMissSystemChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type SystemChanged` - `const SystemChangedSystemChanged SystemChanged = "system_changed"` - `type BetaCacheMissToolsChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type ToolsChanged` - `const ToolsChangedToolsChanged ToolsChanged = "tools_changed"` - `type BetaCacheMissMessagesChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type MessagesChanged` - `const MessagesChangedMessagesChanged MessagesChanged = "messages_changed"` - `type BetaCacheMissPreviousMessageNotFound struct{…}` - `Type PreviousMessageNotFound` - `const PreviousMessageNotFoundPreviousMessageNotFound PreviousMessageNotFound = "previous_message_not_found"` - `type BetaCacheMissUnavailable struct{…}` - `Type Unavailable` - `const UnavailableUnavailable Unavailable = "unavailable"` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type Model string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `const ModelClaudeOpus4_1 Model = "claude-opus-4-1"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_0 Model = "claude-opus-4-0"` Powerful model for complex tasks - `const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"` Powerful model for complex tasks - `const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"` High-performance model with extended thinking - `const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"` High-performance model with extended thinking - `const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"` Fast and cost-effective model - `string` - `Role Assistant` Conversational role of the generated message. This will always be `"assistant"`. - `const AssistantAssistant Assistant = "assistant"` - `StopDetails BetaRefusalStopDetails` Structured information about a refusal. - `Category BetaRefusalStopDetailsCategory` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `const BetaRefusalStopDetailsCategoryCyber BetaRefusalStopDetailsCategory = "cyber"` - `const BetaRefusalStopDetailsCategoryBio BetaRefusalStopDetailsCategory = "bio"` - `Explanation string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `Type Refusal` - `const RefusalRefusal Refusal = "refusal"` - `StopReason BetaStopReason` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `const BetaStopReasonEndTurn BetaStopReason = "end_turn"` - `const BetaStopReasonMaxTokens BetaStopReason = "max_tokens"` - `const BetaStopReasonStopSequence BetaStopReason = "stop_sequence"` - `const BetaStopReasonToolUse BetaStopReason = "tool_use"` - `const BetaStopReasonPauseTurn BetaStopReason = "pause_turn"` - `const BetaStopReasonCompaction BetaStopReason = "compaction"` - `const BetaStopReasonRefusal BetaStopReason = "refusal"` - `const BetaStopReasonModelContextWindowExceeded BetaStopReason = "model_context_window_exceeded"` - `StopSequence string` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `Type Message` Object type. For Messages, this is always `"message"`. - `const MessageMessage Message = "message"` - `Usage BetaUsage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `CacheCreation 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. - `InferenceGeo string` The geographic region where inference was performed for this request. - `InputTokens int64` The number of input tokens which were used. - `Iterations BetaIterationsUsage` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the true context window size from the last iteration - Understand token accumulation across server-side tool use loops - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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 Message` Usage for a sampling iteration - `const MessageMessage Message = "message"` - `type BetaCompactionIterationUsage struct{…}` Token usage for a compaction iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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 - `const CompactionCompaction Compaction = "compaction"` - `type BetaAdvisorMessageIterationUsage struct{…}` Token usage for an advisor sub-inference iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. - `Type AdvisorMessage` Usage for an advisor sub-inference iteration - `const AdvisorMessageAdvisorMessage AdvisorMessage = "advisor_message"` - `OutputTokens int64` The number of output tokens which were used. - `OutputTokensDetails BetaOutputTokensDetails` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `ThinkingTokens int64` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. - `ServerToolUse BetaServerToolUsage` The number of server tool requests. - `WebFetchRequests int64` The number of web fetch tool requests. - `WebSearchRequests int64` The number of web search tool requests. - `ServiceTier BetaUsageServiceTier` If the request used the priority, standard, or batch tier. - `const BetaUsageServiceTierStandard BetaUsageServiceTier = "standard"` - `const BetaUsageServiceTierPriority BetaUsageServiceTier = "priority"` - `const BetaUsageServiceTierBatch BetaUsageServiceTier = "batch"` - `Speed BetaUsageSpeed` The inference speed mode used for this request. - `const BetaUsageSpeedStandard BetaUsageSpeed = "standard"` - `const BetaUsageSpeedFast BetaUsageSpeed = "fast"` - `Type MessageStart` - `const MessageStartMessageStart MessageStart = "message_start"` - `type BetaRawMessageDeltaEvent struct{…}` - `ContextManagement BetaContextManagementResponse` Information about context management strategies applied during the request - `Delta BetaRawMessageDeltaEventDelta` - `Container BetaContainer` Information about the container used in the request (for the code execution tool) - `StopDetails BetaRefusalStopDetails` Structured information about a refusal. - `StopReason BetaStopReason` - `StopSequence string` - `Type MessageDelta` - `const MessageDeltaMessageDelta MessageDelta = "message_delta"` - `Usage BetaMessageDeltaUsage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `CacheCreationInputTokens int64` The cumulative number of input tokens used to create the cache entry. - `CacheReadInputTokens int64` The cumulative number of input tokens read from the cache. - `InputTokens int64` The cumulative number of input tokens which were used. - `Iterations BetaIterationsUsage` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the true context window size from the last iteration - Understand token accumulation across server-side tool use loops - `OutputTokens int64` The cumulative number of output tokens which were used. - `OutputTokensDetails BetaOutputTokensDetails` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `ServerToolUse BetaServerToolUsage` The number of server tool requests. - `type BetaRawMessageStopEvent struct{…}` - `Type MessageStop` - `const MessageStopMessageStop MessageStop = "message_stop"` - `type BetaRawContentBlockStartEvent struct{…}` - `ContentBlock BetaRawContentBlockStartEventContentBlockUnion` Response model for a file uploaded to the container. - `type BetaTextBlock struct{…}` - `type BetaThinkingBlock struct{…}` - `type BetaRedactedThinkingBlock struct{…}` - `type BetaToolUseBlock struct{…}` - `type BetaServerToolUseBlock struct{…}` - `type BetaWebSearchToolResultBlock struct{…}` - `type BetaWebFetchToolResultBlock struct{…}` - `type BetaAdvisorToolResultBlock struct{…}` - `type BetaCodeExecutionToolResultBlock struct{…}` - `type BetaBashCodeExecutionToolResultBlock struct{…}` - `type BetaTextEditorCodeExecutionToolResultBlock struct{…}` - `type BetaToolSearchToolResultBlock struct{…}` - `type BetaMCPToolUseBlock struct{…}` - `type BetaMCPToolResultBlock struct{…}` - `type BetaContainerUploadBlock struct{…}` Response model for a file uploaded to the container. - `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. - `Index int64` - `Type ContentBlockStart` - `const ContentBlockStartContentBlockStart ContentBlockStart = "content_block_start"` - `type BetaRawContentBlockDeltaEvent struct{…}` - `Delta BetaRawContentBlockDeltaUnion` - `type BetaTextDelta struct{…}` - `Text string` - `Type TextDelta` - `const TextDeltaTextDelta TextDelta = "text_delta"` - `type BetaInputJSONDelta struct{…}` - `PartialJSON string` - `Type InputJSONDelta` - `const InputJSONDeltaInputJSONDelta InputJSONDelta = "input_json_delta"` - `type BetaCitationsDelta struct{…}` - `Citation BetaCitationsDeltaCitationUnion` - `type BetaCitationCharLocation struct{…}` - `type BetaCitationPageLocation struct{…}` - `type BetaCitationContentBlockLocation struct{…}` - `type BetaCitationsWebSearchResultLocation struct{…}` - `type BetaCitationSearchResultLocation struct{…}` - `Type CitationsDelta` - `const CitationsDeltaCitationsDelta CitationsDelta = "citations_delta"` - `type BetaThinkingDelta struct{…}` - `EstimatedTokens int64` Per-frame increment of a coarse, running estimate of the tokens this thinking block has produced so far. Present whenever the `thinking-token-count-2026-05-13` beta is set; `null` unless `thinking.display` resolves to `"omitted"` and a count is due this frame. Sum the increments across `thinking_delta` frames on this block for a progress indicator. Each increment is a non-negative multiple of a fixed quantum and the cadence is rate-limited, so this is a deliberately lossy display hint, not a billable count; `usage.output_tokens` remains authoritative. - `Thinking string` - `Type ThinkingDelta` - `const ThinkingDeltaThinkingDelta ThinkingDelta = "thinking_delta"` - `type BetaSignatureDelta struct{…}` - `Signature string` - `Type SignatureDelta` - `const SignatureDeltaSignatureDelta SignatureDelta = "signature_delta"` - `type BetaCompactionContentBlockDelta struct{…}` - `Content string` - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `Type CompactionDelta` - `const CompactionDeltaCompactionDelta CompactionDelta = "compaction_delta"` - `Index int64` - `Type ContentBlockDelta` - `const ContentBlockDeltaContentBlockDelta ContentBlockDelta = "content_block_delta"` - `type BetaRawContentBlockStopEvent struct{…}` - `Index int64` - `Type ContentBlockStop` - `const ContentBlockStopContentBlockStop ContentBlockStop = "content_block_stop"` ### Beta Redacted Thinking Block - `type BetaRedactedThinkingBlock struct{…}` - `Data string` - `Type RedactedThinking` - `const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"` ### Beta Redacted Thinking Block Param - `type BetaRedactedThinkingBlockParamResp struct{…}` - `Data string` - `Type RedactedThinking` - `const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"` ### Beta Refusal Stop Details - `type BetaRefusalStopDetails struct{…}` Structured information about a refusal. - `Category BetaRefusalStopDetailsCategory` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `const BetaRefusalStopDetailsCategoryCyber BetaRefusalStopDetailsCategory = "cyber"` - `const BetaRefusalStopDetailsCategoryBio BetaRefusalStopDetailsCategory = "bio"` - `Explanation string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `Type Refusal` - `const RefusalRefusal Refusal = "refusal"` ### Beta Request Document Block - `type BetaRequestDocumentBlock struct{…}` - `Source BetaRequestDocumentBlockSourceUnion` - `type BetaBase64PDFSource struct{…}` - `Data string` - `MediaType ApplicationPDF` - `const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaPlainTextSource struct{…}` - `Data string` - `MediaType TextPlain` - `const TextPlainTextPlain TextPlain = "text/plain"` - `Type Text` - `const TextText Text = "text"` - `type BetaContentBlockSource struct{…}` - `Content BetaContentBlockSourceContentUnion` - `string` - `[]BetaContentBlockSourceContentUnion` - `type BetaTextBlockParamResp struct{…}` - `Text string` - `Type Text` - `const TextText Text = "text"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations []BetaTextCitationParamUnionResp` - `type BetaCitationCharLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationWebSearchResultLocationParamResp struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `type BetaImageBlockParamResp struct{…}` - `Source BetaImageBlockParamSourceUnionResp` - `type BetaBase64ImageSource struct{…}` - `Data string` - `MediaType BetaBase64ImageSourceMediaType` - `const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"` - `const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"` - `const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"` - `const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaURLImageSource struct{…}` - `Type URL` - `const URLURL URL = "url"` - `URL string` - `type BetaFileImageSource struct{…}` - `FileID string` - `Type File` - `const FileFile File = "file"` - `Type Image` - `const ImageImage Image = "image"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Content` - `const ContentContent Content = "content"` - `type BetaURLPDFSource struct{…}` - `Type URL` - `const URLURL URL = "url"` - `URL string` - `type BetaFileDocumentSource struct{…}` - `FileID string` - `Type File` - `const FileFile File = "file"` - `Type Document` - `const DocumentDocument Document = "document"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` - `Enabled bool` - `Context string` - `Title string` ### Beta Request MCP Server Tool Configuration - `type BetaRequestMCPServerToolConfiguration struct{…}` - `AllowedTools []string` - `Enabled bool` ### Beta Request MCP Server URL Definition - `type BetaRequestMCPServerURLDefinition struct{…}` - `Name string` - `Type URL` - `const URLURL URL = "url"` - `URL string` - `AuthorizationToken string` - `ToolConfiguration BetaRequestMCPServerToolConfiguration` - `AllowedTools []string` - `Enabled bool` ### Beta Request MCP Tool Result Block Param - `type BetaRequestMCPToolResultBlockParamResp struct{…}` - `ToolUseID string` - `Type MCPToolResult` - `const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Content BetaRequestMCPToolResultBlockParamContentUnionResp` - `string` - `[]BetaTextBlockParamResp` - `Text string` - `Type Text` - `const TextText Text = "text"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnionResp` - `type BetaCitationCharLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationWebSearchResultLocationParamResp struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `IsError bool` ### Beta Search Result Block Param - `type BetaSearchResultBlockParamResp struct{…}` - `Content []BetaTextBlockParamResp` - `Text string` - `Type Text` - `const TextText Text = "text"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations []BetaTextCitationParamUnionResp` - `type BetaCitationCharLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationWebSearchResultLocationParamResp struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `Source string` - `Title string` - `Type SearchResult` - `const SearchResultSearchResult SearchResult = "search_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` - `Enabled bool` ### Beta Server Tool Caller - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `ToolID string` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` ### Beta Server Tool Caller 20260120 - `type BetaServerToolCaller20260120 struct{…}` - `ToolID string` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` ### Beta Server Tool Usage - `type BetaServerToolUsage struct{…}` - `WebFetchRequests int64` The number of web fetch tool requests. - `WebSearchRequests int64` The number of web search tool requests. ### Beta Server Tool Use Block - `type BetaServerToolUseBlock struct{…}` - `ID string` - `Input map[string, any]` - `Name BetaServerToolUseBlockName` - `const BetaServerToolUseBlockNameAdvisor BetaServerToolUseBlockName = "advisor"` - `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` - `const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"` - `Caller BetaServerToolUseBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `Type Direct` - `const DirectDirect Direct = "direct"` - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `ToolID string` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `type BetaServerToolCaller20260120 struct{…}` - `ToolID string` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` ### Beta Server Tool Use Block Param - `type BetaServerToolUseBlockParamResp struct{…}` - `ID string` - `Input map[string, any]` - `Name BetaServerToolUseBlockParamName` - `const BetaServerToolUseBlockParamNameAdvisor BetaServerToolUseBlockParamName = "advisor"` - `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` - `const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Caller BetaServerToolUseBlockParamCallerUnionResp` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `Type Direct` - `const DirectDirect Direct = "direct"` - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `ToolID string` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `type BetaServerToolCaller20260120 struct{…}` - `ToolID string` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` ### Beta Signature Delta - `type BetaSignatureDelta struct{…}` - `Signature string` - `Type SignatureDelta` - `const SignatureDeltaSignatureDelta SignatureDelta = "signature_delta"` ### Beta Skill - `type BetaSkill struct{…}` A skill that was loaded in a container (response model). - `SkillID string` Skill ID - `Type BetaSkillType` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `const BetaSkillTypeAnthropic BetaSkillType = "anthropic"` - `const BetaSkillTypeCustom BetaSkillType = "custom"` - `Version string` Skill version or 'latest' for most recent version ### Beta Skill Params - `type BetaSkillParamsResp struct{…}` Specification for a skill to be loaded in a container (request model). - `SkillID string` Skill ID - `Type BetaSkillParamsType` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `const BetaSkillParamsTypeAnthropic BetaSkillParamsType = "anthropic"` - `const BetaSkillParamsTypeCustom BetaSkillParamsType = "custom"` - `Version string` Skill version or 'latest' for most recent version ### Beta Stop Reason - `type BetaStopReason string` - `const BetaStopReasonEndTurn BetaStopReason = "end_turn"` - `const BetaStopReasonMaxTokens BetaStopReason = "max_tokens"` - `const BetaStopReasonStopSequence BetaStopReason = "stop_sequence"` - `const BetaStopReasonToolUse BetaStopReason = "tool_use"` - `const BetaStopReasonPauseTurn BetaStopReason = "pause_turn"` - `const BetaStopReasonCompaction BetaStopReason = "compaction"` - `const BetaStopReasonRefusal BetaStopReason = "refusal"` - `const BetaStopReasonModelContextWindowExceeded BetaStopReason = "model_context_window_exceeded"` ### Beta Text Block - `type BetaTextBlock struct{…}` - `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`. - `type BetaCitationCharLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationsWebSearchResultLocation struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `Text string` - `Type Text` - `const TextText Text = "text"` ### Beta Text Block Param - `type BetaTextBlockParamResp struct{…}` - `Text string` - `Type Text` - `const TextText Text = "text"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations []BetaTextCitationParamUnionResp` - `type BetaCitationCharLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationWebSearchResultLocationParamResp struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` ### Beta Text Citation - `type BetaTextCitationUnion interface{…}` - `type BetaCitationCharLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationsWebSearchResultLocation struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` ### Beta Text Citation Param - `type BetaTextCitationParamUnionResp interface{…}` - `type BetaCitationCharLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationWebSearchResultLocationParamResp struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` ### Beta Text Delta - `type BetaTextDelta struct{…}` - `Text string` - `Type TextDelta` - `const TextDeltaTextDelta TextDelta = "text_delta"` ### Beta Text Editor Code Execution Create Result Block - `type BetaTextEditorCodeExecutionCreateResultBlock struct{…}` - `IsFileUpdate bool` - `Type TextEditorCodeExecutionCreateResult` - `const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"` ### Beta Text Editor Code Execution Create Result Block Param - `type BetaTextEditorCodeExecutionCreateResultBlockParamResp struct{…}` - `IsFileUpdate bool` - `Type TextEditorCodeExecutionCreateResult` - `const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"` ### Beta Text Editor Code Execution Str Replace Result Block - `type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}` - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` - `Type TextEditorCodeExecutionStrReplaceResult` - `const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"` ### Beta Text Editor Code Execution Str Replace Result Block Param - `type BetaTextEditorCodeExecutionStrReplaceResultBlockParamResp struct{…}` - `Type TextEditorCodeExecutionStrReplaceResult` - `const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"` - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` ### Beta Text Editor Code Execution Tool Result Block - `type BetaTextEditorCodeExecutionToolResultBlock struct{…}` - `Content BetaTextEditorCodeExecutionToolResultBlockContentUnion` - `type BetaTextEditorCodeExecutionToolResultError struct{…}` - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode` - `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` - `const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"` - `type BetaTextEditorCodeExecutionViewResultBlock struct{…}` - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockFileType` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` - `Type TextEditorCodeExecutionViewResult` - `const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"` - `type BetaTextEditorCodeExecutionCreateResultBlock struct{…}` - `IsFileUpdate bool` - `Type TextEditorCodeExecutionCreateResult` - `const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"` - `type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}` - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` - `Type TextEditorCodeExecutionStrReplaceResult` - `const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"` - `ToolUseID string` - `Type TextEditorCodeExecutionToolResult` - `const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"` ### Beta Text Editor Code Execution Tool Result Block Param - `type BetaTextEditorCodeExecutionToolResultBlockParamResp struct{…}` - `Content BetaTextEditorCodeExecutionToolResultBlockParamContentUnionResp` - `type BetaTextEditorCodeExecutionToolResultErrorParamResp struct{…}` - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorParamErrorCode` - `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` - `const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"` - `ErrorMessage string` - `type BetaTextEditorCodeExecutionViewResultBlockParamResp struct{…}` - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockParamFileType` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeText BetaTextEditorCodeExecutionViewResultBlockParamFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeImage BetaTextEditorCodeExecutionViewResultBlockParamFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypePDF BetaTextEditorCodeExecutionViewResultBlockParamFileType = "pdf"` - `Type TextEditorCodeExecutionViewResult` - `const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` - `type BetaTextEditorCodeExecutionCreateResultBlockParamResp struct{…}` - `IsFileUpdate bool` - `Type TextEditorCodeExecutionCreateResult` - `const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"` - `type BetaTextEditorCodeExecutionStrReplaceResultBlockParamResp struct{…}` - `Type TextEditorCodeExecutionStrReplaceResult` - `const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"` - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` - `ToolUseID string` - `Type TextEditorCodeExecutionToolResult` - `const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` ### Beta Text Editor Code Execution Tool Result Error - `type BetaTextEditorCodeExecutionToolResultError struct{…}` - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode` - `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` - `const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"` ### Beta Text Editor Code Execution Tool Result Error Param - `type BetaTextEditorCodeExecutionToolResultErrorParamResp struct{…}` - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorParamErrorCode` - `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` - `const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"` - `ErrorMessage string` ### Beta Text Editor Code Execution View Result Block - `type BetaTextEditorCodeExecutionViewResultBlock struct{…}` - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockFileType` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` - `Type TextEditorCodeExecutionViewResult` - `const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"` ### Beta Text Editor Code Execution View Result Block Param - `type BetaTextEditorCodeExecutionViewResultBlockParamResp struct{…}` - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockParamFileType` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeText BetaTextEditorCodeExecutionViewResultBlockParamFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeImage BetaTextEditorCodeExecutionViewResultBlockParamFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypePDF BetaTextEditorCodeExecutionViewResultBlockParamFileType = "pdf"` - `Type TextEditorCodeExecutionViewResult` - `const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` ### Beta Thinking Block - `type BetaThinkingBlock struct{…}` - `Signature string` - `Thinking string` - `Type Thinking` - `const ThinkingThinking Thinking = "thinking"` ### Beta Thinking Block Param - `type BetaThinkingBlockParamResp struct{…}` - `Signature string` - `Thinking string` - `Type Thinking` - `const ThinkingThinking Thinking = "thinking"` ### Beta Thinking Config Adaptive - `type BetaThinkingConfigAdaptive struct{…}` - `Type Adaptive` - `const AdaptiveAdaptive Adaptive = "adaptive"` - `Display BetaThinkingConfigAdaptiveDisplay` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. - `const BetaThinkingConfigAdaptiveDisplaySummarized BetaThinkingConfigAdaptiveDisplay = "summarized"` - `const BetaThinkingConfigAdaptiveDisplayOmitted BetaThinkingConfigAdaptiveDisplay = "omitted"` ### Beta Thinking Config Disabled - `type BetaThinkingConfigDisabled struct{…}` - `Type Disabled` - `const DisabledDisabled Disabled = "disabled"` ### Beta Thinking Config Enabled - `type BetaThinkingConfigEnabled struct{…}` - `BudgetTokens int64` Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality. Must be ≥1024 and less than `max_tokens`. See [extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details. - `Type Enabled` - `const EnabledEnabled Enabled = "enabled"` - `Display BetaThinkingConfigEnabledDisplay` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. - `const BetaThinkingConfigEnabledDisplaySummarized BetaThinkingConfigEnabledDisplay = "summarized"` - `const BetaThinkingConfigEnabledDisplayOmitted BetaThinkingConfigEnabledDisplay = "omitted"` ### Beta Thinking Config Param - `type BetaThinkingConfigParamUnionResp interface{…}` Configuration for enabling Claude's extended thinking. When enabled, responses include `thinking` content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your `max_tokens` limit. See [extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details. - `type BetaThinkingConfigEnabled struct{…}` - `BudgetTokens int64` Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality. Must be ≥1024 and less than `max_tokens`. See [extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details. - `Type Enabled` - `const EnabledEnabled Enabled = "enabled"` - `Display BetaThinkingConfigEnabledDisplay` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. - `const BetaThinkingConfigEnabledDisplaySummarized BetaThinkingConfigEnabledDisplay = "summarized"` - `const BetaThinkingConfigEnabledDisplayOmitted BetaThinkingConfigEnabledDisplay = "omitted"` - `type BetaThinkingConfigDisabled struct{…}` - `Type Disabled` - `const DisabledDisabled Disabled = "disabled"` - `type BetaThinkingConfigAdaptive struct{…}` - `Type Adaptive` - `const AdaptiveAdaptive Adaptive = "adaptive"` - `Display BetaThinkingConfigAdaptiveDisplay` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. - `const BetaThinkingConfigAdaptiveDisplaySummarized BetaThinkingConfigAdaptiveDisplay = "summarized"` - `const BetaThinkingConfigAdaptiveDisplayOmitted BetaThinkingConfigAdaptiveDisplay = "omitted"` ### Beta Thinking Delta - `type BetaThinkingDelta struct{…}` - `EstimatedTokens int64` Per-frame increment of a coarse, running estimate of the tokens this thinking block has produced so far. Present whenever the `thinking-token-count-2026-05-13` beta is set; `null` unless `thinking.display` resolves to `"omitted"` and a count is due this frame. Sum the increments across `thinking_delta` frames on this block for a progress indicator. Each increment is a non-negative multiple of a fixed quantum and the cadence is rate-limited, so this is a deliberately lossy display hint, not a billable count; `usage.output_tokens` remains authoritative. - `Thinking string` - `Type ThinkingDelta` - `const ThinkingDeltaThinkingDelta ThinkingDelta = "thinking_delta"` ### Beta Thinking Turns - `type BetaThinkingTurns struct{…}` - `Type ThinkingTurns` - `const ThinkingTurnsThinkingTurns ThinkingTurns = "thinking_turns"` - `Value int64` ### Beta Token Task Budget - `type BetaTokenTaskBudget struct{…}` User-configurable total token budget across contexts. - `Total int64` Total token budget across all contexts in the session. - `Type Tokens` The budget type. Currently only 'tokens' is supported. - `const TokensTokens Tokens = "tokens"` - `Remaining int64` Remaining tokens in the budget. Use this to track usage across contexts when implementing compaction client-side. Defaults to total if not provided. ### Beta Tool - `type BetaTool struct{…}` - `InputSchema BetaToolInputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `const ObjectObject Object = "object"` - `Properties map[string, any]` - `Required []string` - `Name string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string` - `const BetaToolAllowedCallerDirect BetaToolAllowedCaller = "direct"` - `const BetaToolAllowedCallerCodeExecution20250825 BetaToolAllowedCaller = "code_execution_20250825"` - `const BetaToolAllowedCallerCodeExecution20260120 BetaToolAllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Description string` Description of what this tool does. Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema. - `EagerInputStreaming bool` Enable eager input streaming for this tool. When true, tool input parameters will be streamed incrementally as they are generated, and types will be inferred on-the-fly rather than buffering the full JSON output. When false, streaming is disabled for this tool even if the fine-grained-tool-streaming beta is active. When null (default), uses the default behavior based on beta headers. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `Type BetaToolType` - `const BetaToolTypeCustom BetaToolType = "custom"` ### Beta Tool Bash 20241022 - `type BetaToolBash20241022 struct{…}` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const BashBash Bash = "bash"` - `Type Bash20241022` - `const Bash20241022Bash20241022 Bash20241022 = "bash_20241022"` - `AllowedCallers []string` - `const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"` - `const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260120 BetaToolBash20241022AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs ### Beta Tool Bash 20250124 - `type BetaToolBash20250124 struct{…}` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const BashBash Bash = "bash"` - `Type Bash20250124` - `const Bash20250124Bash20250124 Bash20250124 = "bash_20250124"` - `AllowedCallers []string` - `const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"` - `const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260120 BetaToolBash20250124AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs ### Beta Tool Choice - `type BetaToolChoiceUnion interface{…}` How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. - `type BetaToolChoiceAuto struct{…}` The model will automatically decide whether to use tools. - `Type Auto` - `const AutoAuto Auto = "auto"` - `DisableParallelToolUse bool` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output at most one tool use. - `type BetaToolChoiceAny struct{…}` The model will use any available tools. - `Type Any` - `const AnyAny Any = "any"` - `DisableParallelToolUse bool` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `type BetaToolChoiceTool struct{…}` The model will use the specified tool with `tool_choice.name`. - `Name string` The name of the tool to use. - `Type Tool` - `const ToolTool Tool = "tool"` - `DisableParallelToolUse bool` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `type BetaToolChoiceNone struct{…}` The model will not be allowed to use tools. - `Type None` - `const NoneNone None = "none"` ### Beta Tool Choice Any - `type BetaToolChoiceAny struct{…}` The model will use any available tools. - `Type Any` - `const AnyAny Any = "any"` - `DisableParallelToolUse bool` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. ### Beta Tool Choice Auto - `type BetaToolChoiceAuto struct{…}` The model will automatically decide whether to use tools. - `Type Auto` - `const AutoAuto Auto = "auto"` - `DisableParallelToolUse bool` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output at most one tool use. ### Beta Tool Choice None - `type BetaToolChoiceNone struct{…}` The model will not be allowed to use tools. - `Type None` - `const NoneNone None = "none"` ### Beta Tool Choice Tool - `type BetaToolChoiceTool struct{…}` The model will use the specified tool with `tool_choice.name`. - `Name string` The name of the tool to use. - `Type Tool` - `const ToolTool Tool = "tool"` - `DisableParallelToolUse bool` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. ### Beta Tool Computer Use 20241022 - `type BetaToolComputerUse20241022 struct{…}` - `DisplayHeightPx int64` The height of the display in pixels. - `DisplayWidthPx int64` The width of the display in pixels. - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const ComputerComputer Computer = "computer"` - `Type Computer20241022` - `const Computer20241022Computer20241022 Computer20241022 = "computer_20241022"` - `AllowedCallers []string` - `const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260120 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64` The X11 display number (e.g. 0, 1) for the display. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs ### Beta Tool Computer Use 20250124 - `type BetaToolComputerUse20250124 struct{…}` - `DisplayHeightPx int64` The height of the display in pixels. - `DisplayWidthPx int64` The width of the display in pixels. - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const ComputerComputer Computer = "computer"` - `Type Computer20250124` - `const Computer20250124Computer20250124 Computer20250124 = "computer_20250124"` - `AllowedCallers []string` - `const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260120 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64` The X11 display number (e.g. 0, 1) for the display. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs ### Beta Tool Computer Use 20251124 - `type BetaToolComputerUse20251124 struct{…}` - `DisplayHeightPx int64` The height of the display in pixels. - `DisplayWidthPx int64` The width of the display in pixels. - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const ComputerComputer Computer = "computer"` - `Type Computer20251124` - `const Computer20251124Computer20251124 Computer20251124 = "computer_20251124"` - `AllowedCallers []string` - `const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260120 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64` The X11 display number (e.g. 0, 1) for the display. - `EnableZoom bool` Whether to enable an action to take a zoomed-in screenshot of the screen. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs ### Beta Tool Reference Block - `type BetaToolReferenceBlock struct{…}` - `ToolName string` - `Type ToolReference` - `const ToolReferenceToolReference ToolReference = "tool_reference"` ### Beta Tool Reference Block Param - `type BetaToolReferenceBlockParamResp struct{…}` Tool reference block that can be included in tool_result content. - `ToolName string` - `Type ToolReference` - `const ToolReferenceToolReference ToolReference = "tool_reference"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` ### Beta Tool Result Block Param - `type BetaToolResultBlockParamResp struct{…}` - `ToolUseID string` - `Type ToolResult` - `const ToolResultToolResult ToolResult = "tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Content []BetaToolResultBlockParamContentUnionResp` - `[]BetaToolResultBlockParamContentUnionResp` - `type BetaTextBlockParamResp struct{…}` - `Text string` - `Type Text` - `const TextText Text = "text"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnionResp` - `type BetaCitationCharLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationWebSearchResultLocationParamResp struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `type BetaImageBlockParamResp struct{…}` - `Source BetaImageBlockParamSourceUnionResp` - `type BetaBase64ImageSource struct{…}` - `Data string` - `MediaType BetaBase64ImageSourceMediaType` - `const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"` - `const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"` - `const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"` - `const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaURLImageSource struct{…}` - `Type URL` - `const URLURL URL = "url"` - `URL string` - `type BetaFileImageSource struct{…}` - `FileID string` - `Type File` - `const FileFile File = "file"` - `Type Image` - `const ImageImage Image = "image"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaSearchResultBlockParamResp struct{…}` - `Content []BetaTextBlockParamResp` - `Text string` - `Type Text` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnionResp` - `Source string` - `Title string` - `Type SearchResult` - `const SearchResultSearchResult SearchResult = "search_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` - `Enabled bool` - `type BetaRequestDocumentBlock struct{…}` - `Source BetaRequestDocumentBlockSourceUnion` - `type BetaBase64PDFSource struct{…}` - `Data string` - `MediaType ApplicationPDF` - `const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaPlainTextSource struct{…}` - `Data string` - `MediaType TextPlain` - `const TextPlainTextPlain TextPlain = "text/plain"` - `Type Text` - `const TextText Text = "text"` - `type BetaContentBlockSource struct{…}` - `Content BetaContentBlockSourceContentUnion` - `string` - `[]BetaContentBlockSourceContentUnion` - `type BetaTextBlockParamResp struct{…}` - `type BetaImageBlockParamResp struct{…}` - `Type Content` - `const ContentContent Content = "content"` - `type BetaURLPDFSource struct{…}` - `Type URL` - `const URLURL URL = "url"` - `URL string` - `type BetaFileDocumentSource struct{…}` - `FileID string` - `Type File` - `const FileFile File = "file"` - `Type Document` - `const DocumentDocument Document = "document"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` - `Context string` - `Title string` - `type BetaToolReferenceBlockParamResp struct{…}` Tool reference block that can be included in tool_result content. - `ToolName string` - `Type ToolReference` - `const ToolReferenceToolReference ToolReference = "tool_reference"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `IsError bool` ### Beta Tool Search Tool Bm25 20251119 - `type BetaToolSearchToolBm25_20251119 struct{…}` - `Name ToolSearchToolBm25` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const ToolSearchToolBm25ToolSearchToolBm25 ToolSearchToolBm25 = "tool_search_tool_bm25"` - `Type BetaToolSearchToolBm25_20251119Type` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"` - `AllowedCallers []string` - `const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool` When true, guarantees schema validation on tool names and inputs ### Beta Tool Search Tool Regex 20251119 - `type BetaToolSearchToolRegex20251119 struct{…}` - `Name ToolSearchToolRegex` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const ToolSearchToolRegexToolSearchToolRegex ToolSearchToolRegex = "tool_search_tool_regex"` - `Type BetaToolSearchToolRegex20251119Type` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"` - `AllowedCallers []string` - `const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool` When true, guarantees schema validation on tool names and inputs ### Beta Tool Search Tool Result Block - `type BetaToolSearchToolResultBlock struct{…}` - `Content BetaToolSearchToolResultBlockContentUnion` - `type BetaToolSearchToolResultError struct{…}` - `ErrorCode BetaToolSearchToolResultErrorErrorCode` - `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` - `const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"` - `type BetaToolSearchToolSearchResultBlock struct{…}` - `ToolReferences []BetaToolReferenceBlock` - `ToolName string` - `Type ToolReference` - `const ToolReferenceToolReference ToolReference = "tool_reference"` - `Type ToolSearchToolSearchResult` - `const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"` - `ToolUseID string` - `Type ToolSearchToolResult` - `const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"` ### Beta Tool Search Tool Result Block Param - `type BetaToolSearchToolResultBlockParamResp struct{…}` - `Content BetaToolSearchToolResultBlockParamContentUnionResp` - `type BetaToolSearchToolResultErrorParamResp struct{…}` - `ErrorCode BetaToolSearchToolResultErrorParamErrorCode` - `const BetaToolSearchToolResultErrorParamErrorCodeInvalidToolInput BetaToolSearchToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaToolSearchToolResultErrorParamErrorCodeUnavailable BetaToolSearchToolResultErrorParamErrorCode = "unavailable"` - `const BetaToolSearchToolResultErrorParamErrorCodeTooManyRequests BetaToolSearchToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaToolSearchToolResultErrorParamErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorParamErrorCode = "execution_time_exceeded"` - `Type ToolSearchToolResultError` - `const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"` - `type BetaToolSearchToolSearchResultBlockParamResp struct{…}` - `ToolReferences []BetaToolReferenceBlockParamResp` - `ToolName string` - `Type ToolReference` - `const ToolReferenceToolReference ToolReference = "tool_reference"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Type ToolSearchToolSearchResult` - `const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"` - `ToolUseID string` - `Type ToolSearchToolResult` - `const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. ### Beta Tool Search Tool Result Error - `type BetaToolSearchToolResultError struct{…}` - `ErrorCode BetaToolSearchToolResultErrorErrorCode` - `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` - `const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"` ### Beta Tool Search Tool Result Error Param - `type BetaToolSearchToolResultErrorParamResp struct{…}` - `ErrorCode BetaToolSearchToolResultErrorParamErrorCode` - `const BetaToolSearchToolResultErrorParamErrorCodeInvalidToolInput BetaToolSearchToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaToolSearchToolResultErrorParamErrorCodeUnavailable BetaToolSearchToolResultErrorParamErrorCode = "unavailable"` - `const BetaToolSearchToolResultErrorParamErrorCodeTooManyRequests BetaToolSearchToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaToolSearchToolResultErrorParamErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorParamErrorCode = "execution_time_exceeded"` - `Type ToolSearchToolResultError` - `const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"` ### Beta Tool Search Tool Search Result Block - `type BetaToolSearchToolSearchResultBlock struct{…}` - `ToolReferences []BetaToolReferenceBlock` - `ToolName string` - `Type ToolReference` - `const ToolReferenceToolReference ToolReference = "tool_reference"` - `Type ToolSearchToolSearchResult` - `const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"` ### Beta Tool Search Tool Search Result Block Param - `type BetaToolSearchToolSearchResultBlockParamResp struct{…}` - `ToolReferences []BetaToolReferenceBlockParamResp` - `ToolName string` - `Type ToolReference` - `const ToolReferenceToolReference ToolReference = "tool_reference"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Type ToolSearchToolSearchResult` - `const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"` ### Beta Tool Text Editor 20241022 - `type BetaToolTextEditor20241022 struct{…}` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const StrReplaceEditorStrReplaceEditor StrReplaceEditor = "str_replace_editor"` - `Type TextEditor20241022` - `const TextEditor20241022TextEditor20241022 TextEditor20241022 = "text_editor_20241022"` - `AllowedCallers []string` - `const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260120 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs ### Beta Tool Text Editor 20250124 - `type BetaToolTextEditor20250124 struct{…}` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const StrReplaceEditorStrReplaceEditor StrReplaceEditor = "str_replace_editor"` - `Type TextEditor20250124` - `const TextEditor20250124TextEditor20250124 TextEditor20250124 = "text_editor_20250124"` - `AllowedCallers []string` - `const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260120 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs ### Beta Tool Text Editor 20250429 - `type BetaToolTextEditor20250429 struct{…}` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const StrReplaceBasedEditToolStrReplaceBasedEditTool StrReplaceBasedEditTool = "str_replace_based_edit_tool"` - `Type TextEditor20250429` - `const TextEditor20250429TextEditor20250429 TextEditor20250429 = "text_editor_20250429"` - `AllowedCallers []string` - `const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260120 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs ### Beta Tool Text Editor 20250728 - `type BetaToolTextEditor20250728 struct{…}` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const StrReplaceBasedEditToolStrReplaceBasedEditTool StrReplaceBasedEditTool = "str_replace_based_edit_tool"` - `Type TextEditor20250728` - `const TextEditor20250728TextEditor20250728 TextEditor20250728 = "text_editor_20250728"` - `AllowedCallers []string` - `const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260120 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `MaxCharacters int64` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. - `Strict bool` When true, guarantees schema validation on tool names and inputs ### Beta Tool Union - `type BetaToolUnion interface{…}` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `type BetaTool struct{…}` - `InputSchema BetaToolInputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `const ObjectObject Object = "object"` - `Properties map[string, any]` - `Required []string` - `Name string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string` - `const BetaToolAllowedCallerDirect BetaToolAllowedCaller = "direct"` - `const BetaToolAllowedCallerCodeExecution20250825 BetaToolAllowedCaller = "code_execution_20250825"` - `const BetaToolAllowedCallerCodeExecution20260120 BetaToolAllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Description string` Description of what this tool does. Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema. - `EagerInputStreaming bool` Enable eager input streaming for this tool. When true, tool input parameters will be streamed incrementally as they are generated, and types will be inferred on-the-fly rather than buffering the full JSON output. When false, streaming is disabled for this tool even if the fine-grained-tool-streaming beta is active. When null (default), uses the default behavior based on beta headers. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `Type BetaToolType` - `const BetaToolTypeCustom BetaToolType = "custom"` - `type BetaToolBash20241022 struct{…}` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const BashBash Bash = "bash"` - `Type Bash20241022` - `const Bash20241022Bash20241022 Bash20241022 = "bash_20241022"` - `AllowedCallers []string` - `const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"` - `const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260120 BetaToolBash20241022AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20250124 struct{…}` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const BashBash Bash = "bash"` - `Type Bash20250124` - `const Bash20250124Bash20250124 Bash20250124 = "bash_20250124"` - `AllowedCallers []string` - `const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"` - `const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260120 BetaToolBash20250124AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250522 struct{…}` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const CodeExecutionCodeExecution CodeExecution = "code_execution"` - `Type CodeExecution20250522` - `const CodeExecution20250522CodeExecution20250522 CodeExecution20250522 = "code_execution_20250522"` - `AllowedCallers []string` - `const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250825 struct{…}` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const CodeExecutionCodeExecution CodeExecution = "code_execution"` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `AllowedCallers []string` - `const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260120 struct{…}` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const CodeExecutionCodeExecution CodeExecution = "code_execution"` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` - `AllowedCallers []string` - `const BetaCodeExecutionTool20260120AllowedCallerDirect BetaCodeExecutionTool20260120AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20241022 struct{…}` - `DisplayHeightPx int64` The height of the display in pixels. - `DisplayWidthPx int64` The width of the display in pixels. - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const ComputerComputer Computer = "computer"` - `Type Computer20241022` - `const Computer20241022Computer20241022 Computer20241022 = "computer_20241022"` - `AllowedCallers []string` - `const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260120 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64` The X11 display number (e.g. 0, 1) for the display. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaMemoryTool20250818 struct{…}` - `Name Memory` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const MemoryMemory Memory = "memory"` - `Type Memory20250818` - `const Memory20250818Memory20250818 Memory20250818 = "memory_20250818"` - `AllowedCallers []string` - `const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260120 BetaMemoryTool20250818AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20250124 struct{…}` - `DisplayHeightPx int64` The height of the display in pixels. - `DisplayWidthPx int64` The width of the display in pixels. - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const ComputerComputer Computer = "computer"` - `Type Computer20250124` - `const Computer20250124Computer20250124 Computer20250124 = "computer_20250124"` - `AllowedCallers []string` - `const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260120 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64` The X11 display number (e.g. 0, 1) for the display. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20241022 struct{…}` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const StrReplaceEditorStrReplaceEditor StrReplaceEditor = "str_replace_editor"` - `Type TextEditor20241022` - `const TextEditor20241022TextEditor20241022 TextEditor20241022 = "text_editor_20241022"` - `AllowedCallers []string` - `const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260120 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20251124 struct{…}` - `DisplayHeightPx int64` The height of the display in pixels. - `DisplayWidthPx int64` The width of the display in pixels. - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const ComputerComputer Computer = "computer"` - `Type Computer20251124` - `const Computer20251124Computer20251124 Computer20251124 = "computer_20251124"` - `AllowedCallers []string` - `const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260120 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64` The X11 display number (e.g. 0, 1) for the display. - `EnableZoom bool` Whether to enable an action to take a zoomed-in screenshot of the screen. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250124 struct{…}` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const StrReplaceEditorStrReplaceEditor StrReplaceEditor = "str_replace_editor"` - `Type TextEditor20250124` - `const TextEditor20250124TextEditor20250124 TextEditor20250124 = "text_editor_20250124"` - `AllowedCallers []string` - `const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260120 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250429 struct{…}` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const StrReplaceBasedEditToolStrReplaceBasedEditTool StrReplaceBasedEditTool = "str_replace_based_edit_tool"` - `Type TextEditor20250429` - `const TextEditor20250429TextEditor20250429 TextEditor20250429 = "text_editor_20250429"` - `AllowedCallers []string` - `const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260120 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250728 struct{…}` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const StrReplaceBasedEditToolStrReplaceBasedEditTool StrReplaceBasedEditTool = "str_replace_based_edit_tool"` - `Type TextEditor20250728` - `const TextEditor20250728TextEditor20250728 TextEditor20250728 = "text_editor_20250728"` - `AllowedCallers []string` - `const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260120 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `MaxCharacters int64` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20250305 struct{…}` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const WebSearchWebSearch WebSearch = "web_search"` - `Type WebSearch20250305` - `const WebSearch20250305WebSearch20250305 WebSearch20250305 = "web_search_20250305"` - `AllowedCallers []string` - `const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260120 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260120"` - `AllowedDomains []string` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `const ApproximateApproximate Approximate = "approximate"` - `City string` The city of the user. - `Country string` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. - `Region string` The region of the user. - `Timezone string` The [IANA timezone](https://nodatime.org/TimeZones) of the user. - `type BetaWebFetchTool20250910 struct{…}` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const WebFetchWebFetch WebFetch = "web_fetch"` - `Type WebFetch20250910` - `const WebFetch20250910WebFetch20250910 WebFetch20250910 = "web_fetch_20250910"` - `AllowedCallers []string` - `const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260120 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260120"` - `AllowedDomains []string` List of domains to allow fetching from - `BlockedDomains []string` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` Citations configuration for fetched documents. Citations are disabled by default. - `Enabled bool` - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20260209 struct{…}` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const WebSearchWebSearch WebSearch = "web_search"` - `Type WebSearch20260209` - `const WebSearch20260209WebSearch20260209 WebSearch20260209 = "web_search_20260209"` - `AllowedCallers []string` - `const BetaWebSearchTool20260209AllowedCallerDirect BetaWebSearchTool20260209AllowedCaller = "direct"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20250825 BetaWebSearchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260120 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260120"` - `AllowedDomains []string` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260209 struct{…}` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const WebFetchWebFetch WebFetch = "web_fetch"` - `Type WebFetch20260209` - `const WebFetch20260209WebFetch20260209 WebFetch20260209 = "web_fetch_20260209"` - `AllowedCallers []string` - `const BetaWebFetchTool20260209AllowedCallerDirect BetaWebFetchTool20260209AllowedCaller = "direct"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20250825 BetaWebFetchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260120 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260120"` - `AllowedDomains []string` List of domains to allow fetching from - `BlockedDomains []string` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaWebFetchTool20260309 struct{…}` Web fetch tool with use_cache parameter for bypassing cached content. - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const WebFetchWebFetch WebFetch = "web_fetch"` - `Type WebFetch20260309` - `const WebFetch20260309WebFetch20260309 WebFetch20260309 = "web_fetch_20260309"` - `AllowedCallers []string` - `const BetaWebFetchTool20260309AllowedCallerDirect BetaWebFetchTool20260309AllowedCaller = "direct"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20250825 BetaWebFetchTool20260309AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260120 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260120"` - `AllowedDomains []string` List of domains to allow fetching from - `BlockedDomains []string` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `UseCache bool` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaAdvisorTool20260301 struct{…}` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type Model string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `const ModelClaudeOpus4_1 Model = "claude-opus-4-1"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_0 Model = "claude-opus-4-0"` Powerful model for complex tasks - `const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"` Powerful model for complex tasks - `const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"` High-performance model with extended thinking - `const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"` High-performance model with extended thinking - `const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"` Fast and cost-effective model - `string` - `Name Advisor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const AdvisorAdvisor Advisor = "advisor"` - `Type Advisor20260301` - `const Advisor20260301Advisor20260301 Advisor20260301 = "advisor_20260301"` - `AllowedCallers []string` - `const BetaAdvisorTool20260301AllowedCallerDirect BetaAdvisorTool20260301AllowedCaller = "direct"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20250825 BetaAdvisorTool20260301AllowedCaller = "code_execution_20250825"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260120 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Caching BetaCacheControlEphemeral` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolBm25_20251119 struct{…}` - `Name ToolSearchToolBm25` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const ToolSearchToolBm25ToolSearchToolBm25 ToolSearchToolBm25 = "tool_search_tool_bm25"` - `Type BetaToolSearchToolBm25_20251119Type` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"` - `AllowedCallers []string` - `const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolRegex20251119 struct{…}` - `Name ToolSearchToolRegex` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const ToolSearchToolRegexToolSearchToolRegex ToolSearchToolRegex = "tool_search_tool_regex"` - `Type BetaToolSearchToolRegex20251119Type` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"` - `AllowedCallers []string` - `const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaMCPToolset struct{…}` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `MCPServerName string` Name of the MCP server to configure tools for - `Type MCPToolset` - `const MCPToolsetMCPToolset MCPToolset = "mcp_toolset"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Configs map[string, BetaMCPToolConfig]` Configuration overrides for specific tools, keyed by tool name - `DeferLoading bool` - `Enabled bool` - `DefaultConfig BetaMCPToolDefaultConfig` Default configuration applied to all tools from this server - `DeferLoading bool` - `Enabled bool` ### Beta Tool Use Block - `type BetaToolUseBlock struct{…}` - `ID string` - `Input map[string, any]` - `Name string` - `Type ToolUse` - `const ToolUseToolUse ToolUse = "tool_use"` - `Caller BetaToolUseBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `Type Direct` - `const DirectDirect Direct = "direct"` - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `ToolID string` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `type BetaServerToolCaller20260120 struct{…}` - `ToolID string` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` ### Beta Tool Use Block Param - `type BetaToolUseBlockParamResp struct{…}` - `ID string` - `Input map[string, any]` - `Name string` - `Type ToolUse` - `const ToolUseToolUse ToolUse = "tool_use"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Caller BetaToolUseBlockParamCallerUnionResp` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `Type Direct` - `const DirectDirect Direct = "direct"` - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `ToolID string` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `type BetaServerToolCaller20260120 struct{…}` - `ToolID string` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` ### Beta Tool Uses Keep - `type BetaToolUsesKeep struct{…}` - `Type ToolUses` - `const ToolUsesToolUses ToolUses = "tool_uses"` - `Value int64` ### Beta Tool Uses Trigger - `type BetaToolUsesTrigger struct{…}` - `Type ToolUses` - `const ToolUsesToolUses ToolUses = "tool_uses"` - `Value int64` ### Beta URL Image Source - `type BetaURLImageSource struct{…}` - `Type URL` - `const URLURL URL = "url"` - `URL string` ### Beta URL PDF Source - `type BetaURLPDFSource struct{…}` - `Type URL` - `const URLURL URL = "url"` - `URL string` ### Beta Usage - `type BetaUsage struct{…}` - `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. - `InferenceGeo string` The geographic region where inference was performed for this request. - `InputTokens int64` The number of input tokens which were used. - `Iterations BetaIterationsUsage` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the true context window size from the last iteration - Understand token accumulation across server-side tool use loops - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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 Message` Usage for a sampling iteration - `const MessageMessage Message = "message"` - `type BetaCompactionIterationUsage struct{…}` Token usage for a compaction iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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 - `const CompactionCompaction Compaction = "compaction"` - `type BetaAdvisorMessageIterationUsage struct{…}` Token usage for an advisor sub-inference iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type Model string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `const ModelClaudeOpus4_1 Model = "claude-opus-4-1"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_0 Model = "claude-opus-4-0"` Powerful model for complex tasks - `const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"` Powerful model for complex tasks - `const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"` High-performance model with extended thinking - `const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"` High-performance model with extended thinking - `const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"` Fast and cost-effective model - `string` - `OutputTokens int64` The number of output tokens which were used. - `Type AdvisorMessage` Usage for an advisor sub-inference iteration - `const AdvisorMessageAdvisorMessage AdvisorMessage = "advisor_message"` - `OutputTokens int64` The number of output tokens which were used. - `OutputTokensDetails BetaOutputTokensDetails` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `ThinkingTokens int64` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. - `ServerToolUse BetaServerToolUsage` The number of server tool requests. - `WebFetchRequests int64` The number of web fetch tool requests. - `WebSearchRequests int64` The number of web search tool requests. - `ServiceTier BetaUsageServiceTier` If the request used the priority, standard, or batch tier. - `const BetaUsageServiceTierStandard BetaUsageServiceTier = "standard"` - `const BetaUsageServiceTierPriority BetaUsageServiceTier = "priority"` - `const BetaUsageServiceTierBatch BetaUsageServiceTier = "batch"` - `Speed BetaUsageSpeed` The inference speed mode used for this request. - `const BetaUsageSpeedStandard BetaUsageSpeed = "standard"` - `const BetaUsageSpeedFast BetaUsageSpeed = "fast"` ### Beta User Location - `type BetaUserLocation struct{…}` - `Type Approximate` - `const ApproximateApproximate Approximate = "approximate"` - `City string` The city of the user. - `Country string` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. - `Region string` The region of the user. - `Timezone string` The [IANA timezone](https://nodatime.org/TimeZones) of the user. ### Beta Web Fetch Block - `type BetaWebFetchBlock struct{…}` - `Content BetaDocumentBlock` - `Citations BetaCitationConfig` Citation configuration for the document - `Enabled bool` - `Source BetaDocumentBlockSourceUnion` - `type BetaBase64PDFSource struct{…}` - `Data string` - `MediaType ApplicationPDF` - `const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaPlainTextSource struct{…}` - `Data string` - `MediaType TextPlain` - `const TextPlainTextPlain TextPlain = "text/plain"` - `Type Text` - `const TextText Text = "text"` - `Title string` The title of the document - `Type Document` - `const DocumentDocument Document = "document"` - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved - `Type WebFetchResult` - `const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"` - `URL string` Fetched content URL ### Beta Web Fetch Block Param - `type BetaWebFetchBlockParamResp struct{…}` - `Content BetaRequestDocumentBlock` - `Source BetaRequestDocumentBlockSourceUnion` - `type BetaBase64PDFSource struct{…}` - `Data string` - `MediaType ApplicationPDF` - `const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaPlainTextSource struct{…}` - `Data string` - `MediaType TextPlain` - `const TextPlainTextPlain TextPlain = "text/plain"` - `Type Text` - `const TextText Text = "text"` - `type BetaContentBlockSource struct{…}` - `Content BetaContentBlockSourceContentUnion` - `string` - `[]BetaContentBlockSourceContentUnion` - `type BetaTextBlockParamResp struct{…}` - `Text string` - `Type Text` - `const TextText Text = "text"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations []BetaTextCitationParamUnionResp` - `type BetaCitationCharLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationWebSearchResultLocationParamResp struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `type BetaImageBlockParamResp struct{…}` - `Source BetaImageBlockParamSourceUnionResp` - `type BetaBase64ImageSource struct{…}` - `Data string` - `MediaType BetaBase64ImageSourceMediaType` - `const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"` - `const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"` - `const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"` - `const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaURLImageSource struct{…}` - `Type URL` - `const URLURL URL = "url"` - `URL string` - `type BetaFileImageSource struct{…}` - `FileID string` - `Type File` - `const FileFile File = "file"` - `Type Image` - `const ImageImage Image = "image"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Content` - `const ContentContent Content = "content"` - `type BetaURLPDFSource struct{…}` - `Type URL` - `const URLURL URL = "url"` - `URL string` - `type BetaFileDocumentSource struct{…}` - `FileID string` - `Type File` - `const FileFile File = "file"` - `Type Document` - `const DocumentDocument Document = "document"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` - `Enabled bool` - `Context string` - `Title string` - `Type WebFetchResult` - `const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"` - `URL string` Fetched content URL - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved ### Beta Web Fetch Tool 20250910 - `type BetaWebFetchTool20250910 struct{…}` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const WebFetchWebFetch WebFetch = "web_fetch"` - `Type WebFetch20250910` - `const WebFetch20250910WebFetch20250910 WebFetch20250910 = "web_fetch_20250910"` - `AllowedCallers []string` - `const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260120 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260120"` - `AllowedDomains []string` List of domains to allow fetching from - `BlockedDomains []string` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations BetaCitationsConfigParamResp` Citations configuration for fetched documents. Citations are disabled by default. - `Enabled bool` - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs ### Beta Web Fetch Tool 20260209 - `type BetaWebFetchTool20260209 struct{…}` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const WebFetchWebFetch WebFetch = "web_fetch"` - `Type WebFetch20260209` - `const WebFetch20260209WebFetch20260209 WebFetch20260209 = "web_fetch_20260209"` - `AllowedCallers []string` - `const BetaWebFetchTool20260209AllowedCallerDirect BetaWebFetchTool20260209AllowedCaller = "direct"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20250825 BetaWebFetchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260120 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260120"` - `AllowedDomains []string` List of domains to allow fetching from - `BlockedDomains []string` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations BetaCitationsConfigParamResp` Citations configuration for fetched documents. Citations are disabled by default. - `Enabled bool` - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs ### Beta Web Fetch Tool 20260309 - `type BetaWebFetchTool20260309 struct{…}` Web fetch tool with use_cache parameter for bypassing cached content. - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const WebFetchWebFetch WebFetch = "web_fetch"` - `Type WebFetch20260309` - `const WebFetch20260309WebFetch20260309 WebFetch20260309 = "web_fetch_20260309"` - `AllowedCallers []string` - `const BetaWebFetchTool20260309AllowedCallerDirect BetaWebFetchTool20260309AllowedCaller = "direct"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20250825 BetaWebFetchTool20260309AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260120 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260120"` - `AllowedDomains []string` List of domains to allow fetching from - `BlockedDomains []string` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations BetaCitationsConfigParamResp` Citations configuration for fetched documents. Citations are disabled by default. - `Enabled bool` - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `UseCache bool` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. ### Beta Web Fetch Tool Result Block - `type BetaWebFetchToolResultBlock struct{…}` - `Content BetaWebFetchToolResultBlockContentUnion` - `type BetaWebFetchToolResultErrorBlock struct{…}` - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `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` - `const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"` - `type BetaWebFetchBlock struct{…}` - `Content BetaDocumentBlock` - `Citations BetaCitationConfig` Citation configuration for the document - `Enabled bool` - `Source BetaDocumentBlockSourceUnion` - `type BetaBase64PDFSource struct{…}` - `Data string` - `MediaType ApplicationPDF` - `const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaPlainTextSource struct{…}` - `Data string` - `MediaType TextPlain` - `const TextPlainTextPlain TextPlain = "text/plain"` - `Type Text` - `const TextText Text = "text"` - `Title string` The title of the document - `Type Document` - `const DocumentDocument Document = "document"` - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved - `Type WebFetchResult` - `const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"` - `URL string` Fetched content URL - `ToolUseID string` - `Type WebFetchToolResult` - `const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"` - `Caller BetaWebFetchToolResultBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `Type Direct` - `const DirectDirect Direct = "direct"` - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `ToolID string` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `type BetaServerToolCaller20260120 struct{…}` - `ToolID string` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` ### Beta Web Fetch Tool Result Block Param - `type BetaWebFetchToolResultBlockParamResp struct{…}` - `Content BetaWebFetchToolResultBlockParamContentUnionResp` - `type BetaWebFetchToolResultErrorBlockParamResp struct{…}` - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `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` - `const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"` - `type BetaWebFetchBlockParamResp struct{…}` - `Content BetaRequestDocumentBlock` - `Source BetaRequestDocumentBlockSourceUnion` - `type BetaBase64PDFSource struct{…}` - `Data string` - `MediaType ApplicationPDF` - `const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaPlainTextSource struct{…}` - `Data string` - `MediaType TextPlain` - `const TextPlainTextPlain TextPlain = "text/plain"` - `Type Text` - `const TextText Text = "text"` - `type BetaContentBlockSource struct{…}` - `Content BetaContentBlockSourceContentUnion` - `string` - `[]BetaContentBlockSourceContentUnion` - `type BetaTextBlockParamResp struct{…}` - `Text string` - `Type Text` - `const TextText Text = "text"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations []BetaTextCitationParamUnionResp` - `type BetaCitationCharLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationWebSearchResultLocationParamResp struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `type BetaImageBlockParamResp struct{…}` - `Source BetaImageBlockParamSourceUnionResp` - `type BetaBase64ImageSource struct{…}` - `Data string` - `MediaType BetaBase64ImageSourceMediaType` - `const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"` - `const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"` - `const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"` - `const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaURLImageSource struct{…}` - `Type URL` - `const URLURL URL = "url"` - `URL string` - `type BetaFileImageSource struct{…}` - `FileID string` - `Type File` - `const FileFile File = "file"` - `Type Image` - `const ImageImage Image = "image"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Content` - `const ContentContent Content = "content"` - `type BetaURLPDFSource struct{…}` - `Type URL` - `const URLURL URL = "url"` - `URL string` - `type BetaFileDocumentSource struct{…}` - `FileID string` - `Type File` - `const FileFile File = "file"` - `Type Document` - `const DocumentDocument Document = "document"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` - `Enabled bool` - `Context string` - `Title string` - `Type WebFetchResult` - `const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"` - `URL string` Fetched content URL - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved - `ToolUseID string` - `Type WebFetchToolResult` - `const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Caller BetaWebFetchToolResultBlockParamCallerUnionResp` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `Type Direct` - `const DirectDirect Direct = "direct"` - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `ToolID string` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `type BetaServerToolCaller20260120 struct{…}` - `ToolID string` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` ### Beta Web Fetch Tool Result Error Block - `type BetaWebFetchToolResultErrorBlock struct{…}` - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `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` - `const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"` ### Beta Web Fetch Tool Result Error Block Param - `type BetaWebFetchToolResultErrorBlockParamResp struct{…}` - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `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` - `const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"` ### Beta Web Fetch Tool Result Error Code - `type BetaWebFetchToolResultErrorCode string` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `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"` ### Beta Web Search Result Block - `type BetaWebSearchResultBlock struct{…}` - `EncryptedContent string` - `PageAge string` - `Title string` - `Type WebSearchResult` - `const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"` - `URL string` ### Beta Web Search Result Block Param - `type BetaWebSearchResultBlockParamResp struct{…}` - `EncryptedContent string` - `Title string` - `Type WebSearchResult` - `const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"` - `URL string` - `PageAge string` ### Beta Web Search Tool 20250305 - `type BetaWebSearchTool20250305 struct{…}` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const WebSearchWebSearch WebSearch = "web_search"` - `Type WebSearch20250305` - `const WebSearch20250305WebSearch20250305 WebSearch20250305 = "web_search_20250305"` - `AllowedCallers []string` - `const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260120 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260120"` - `AllowedDomains []string` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `const ApproximateApproximate Approximate = "approximate"` - `City string` The city of the user. - `Country string` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. - `Region string` The region of the user. - `Timezone string` The [IANA timezone](https://nodatime.org/TimeZones) of the user. ### Beta Web Search Tool 20260209 - `type BetaWebSearchTool20260209 struct{…}` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const WebSearchWebSearch WebSearch = "web_search"` - `Type WebSearch20260209` - `const WebSearch20260209WebSearch20260209 WebSearch20260209 = "web_search_20260209"` - `AllowedCallers []string` - `const BetaWebSearchTool20260209AllowedCallerDirect BetaWebSearchTool20260209AllowedCaller = "direct"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20250825 BetaWebSearchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260120 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260120"` - `AllowedDomains []string` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `const ApproximateApproximate Approximate = "approximate"` - `City string` The city of the user. - `Country string` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. - `Region string` The region of the user. - `Timezone string` The [IANA timezone](https://nodatime.org/TimeZones) of the user. ### Beta Web Search Tool Request Error - `type BetaWebSearchToolRequestError struct{…}` - `ErrorCode BetaWebSearchToolResultErrorCode` - `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` - `const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"` ### Beta Web Search Tool Result Block - `type BetaWebSearchToolResultBlock struct{…}` - `Content BetaWebSearchToolResultBlockContentUnion` - `type BetaWebSearchToolResultError struct{…}` - `ErrorCode BetaWebSearchToolResultErrorCode` - `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` - `const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"` - `type BetaWebSearchToolResultBlockContentArray []BetaWebSearchResultBlock` - `EncryptedContent string` - `PageAge string` - `Title string` - `Type WebSearchResult` - `const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"` - `URL string` - `ToolUseID string` - `Type WebSearchToolResult` - `const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"` - `Caller BetaWebSearchToolResultBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `Type Direct` - `const DirectDirect Direct = "direct"` - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `ToolID string` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `type BetaServerToolCaller20260120 struct{…}` - `ToolID string` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` ### Beta Web Search Tool Result Block Content - `type BetaWebSearchToolResultBlockContentUnion interface{…}` - `type BetaWebSearchToolResultError struct{…}` - `ErrorCode BetaWebSearchToolResultErrorCode` - `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` - `const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"` - `type BetaWebSearchToolResultBlockContentArray []BetaWebSearchResultBlock` - `EncryptedContent string` - `PageAge string` - `Title string` - `Type WebSearchResult` - `const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"` - `URL string` ### Beta Web Search Tool Result Block Param - `type BetaWebSearchToolResultBlockParamResp struct{…}` - `Content BetaWebSearchToolResultBlockParamContentUnionResp` - `[]BetaWebSearchResultBlockParamResp` - `EncryptedContent string` - `Title string` - `Type WebSearchResult` - `const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"` - `URL string` - `PageAge string` - `type BetaWebSearchToolRequestError struct{…}` - `ErrorCode BetaWebSearchToolResultErrorCode` - `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` - `const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"` - `ToolUseID string` - `Type WebSearchToolResult` - `const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Caller BetaWebSearchToolResultBlockParamCallerUnionResp` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `Type Direct` - `const DirectDirect Direct = "direct"` - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `ToolID string` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `type BetaServerToolCaller20260120 struct{…}` - `ToolID string` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` ### Beta Web Search Tool Result Block Param Content - `type BetaWebSearchToolResultBlockParamContentUnionResp interface{…}` - `[]BetaWebSearchResultBlockParamResp` - `EncryptedContent string` - `Title string` - `Type WebSearchResult` - `const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"` - `URL string` - `PageAge string` - `type BetaWebSearchToolRequestError struct{…}` - `ErrorCode BetaWebSearchToolResultErrorCode` - `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` - `const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"` ### Beta Web Search Tool Result Error - `type BetaWebSearchToolResultError struct{…}` - `ErrorCode BetaWebSearchToolResultErrorCode` - `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` - `const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"` ### Beta Web Search Tool Result Error Code - `type BetaWebSearchToolResultErrorCode string` - `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"` # Batches ## Create a Message Batch `client.Beta.Messages.Batches.New(ctx, params) (*BetaMessageBatch, error)` **post** `/v1/messages/batches` Send a batch of Message creation requests. The Message Batches API can be used to process multiple Messages API requests at once. Once a Message Batch is created, it begins processing immediately. Batches can take up to 24 hours to complete. Learn more about the Message Batches API in our [user guide](https://docs.claude.com/en/docs/build-with-claude/batch-processing) ### Parameters - `params BetaMessageBatchNewParams` - `Requests param.Field[[]BetaMessageBatchNewParamsRequest]` Body param: List of requests for prompt completion. Each is an individual request to create a Message. - `CustomID string` Developer-provided ID created for each request in a Message Batch. Useful for matching results to requests, as results may be given out of request order. Must be unique for each request within the Message Batch. - `Params BetaMessageBatchNewParamsRequestParams` Messages API creation parameters for the individual request. See the [Messages API reference](https://docs.claude.com/en/api/messages) for full documentation on available parameters. - `MaxTokens int64` The maximum number of tokens to generate before stopping. Note that our models may stop _before_ reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate. Set to `0` to populate the [prompt cache](https://docs.claude.com/en/docs/build-with-claude/prompt-caching#pre-warming-the-cache) without generating a response. Different models have different maximum values for this parameter. See [models](https://docs.claude.com/en/docs/models-overview) for details. - `Messages []BetaMessageParamResp` Input messages. Our models are trained to operate on alternating `user` and `assistant` conversational turns. When creating a new `Message`, you specify the prior conversational turns with the `messages` parameter, and the model then generates the next `Message` in the conversation. Consecutive `user` or `assistant` turns in your request will be combined into a single turn. Each input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages. If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. Example with a single `user` message: ```json [{"role": "user", "content": "Hello, Claude"}] ``` Example with multiple conversational turns: ```json [ {"role": "user", "content": "Hello there."}, {"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"}, {"role": "user", "content": "Can you explain LLMs in plain English?"}, ] ``` Example with a partially-filled response from Claude: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("}, ] ``` Each input message `content` may be either a single `string` or an array of content blocks, where each block has a specific `type`. Using a `string` for `content` is shorthand for an array of one content block of type `"text"`. The following input messages are equivalent: ```json {"role": "user", "content": "Hello, Claude"} ``` ```json {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]} ``` See [input examples](https://docs.claude.com/en/api/messages-examples). Note that if you want to include a [system prompt](https://docs.claude.com/en/docs/system-prompts), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API. There is a limit of 100,000 messages in a single request. - `Content []BetaContentBlockParamUnionResp` - `[]BetaContentBlockParamUnionResp` - `type BetaTextBlockParamResp struct{…}` - `Text string` - `Type Text` - `const TextText Text = "text"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `const EphemeralEphemeral Ephemeral = "ephemeral"` - `TTL BetaCacheControlEphemeralTTL` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations []BetaTextCitationParamUnionResp` - `type BetaCitationCharLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocationParamResp struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationWebSearchResultLocationParamResp struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocationParamResp struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `type BetaImageBlockParamResp struct{…}` - `Source BetaImageBlockParamSourceUnionResp` - `type BetaBase64ImageSource struct{…}` - `Data string` - `MediaType BetaBase64ImageSourceMediaType` - `const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"` - `const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"` - `const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"` - `const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaURLImageSource struct{…}` - `Type URL` - `const URLURL URL = "url"` - `URL string` - `type BetaFileImageSource struct{…}` - `FileID string` - `Type File` - `const FileFile File = "file"` - `Type Image` - `const ImageImage Image = "image"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaRequestDocumentBlock struct{…}` - `Source BetaRequestDocumentBlockSourceUnion` - `type BetaBase64PDFSource struct{…}` - `Data string` - `MediaType ApplicationPDF` - `const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaPlainTextSource struct{…}` - `Data string` - `MediaType TextPlain` - `const TextPlainTextPlain TextPlain = "text/plain"` - `Type Text` - `const TextText Text = "text"` - `type BetaContentBlockSource struct{…}` - `Content BetaContentBlockSourceContentUnion` - `string` - `[]BetaContentBlockSourceContentUnion` - `type BetaTextBlockParamResp struct{…}` - `type BetaImageBlockParamResp struct{…}` - `Type Content` - `const ContentContent Content = "content"` - `type BetaURLPDFSource struct{…}` - `Type URL` - `const URLURL URL = "url"` - `URL string` - `type BetaFileDocumentSource struct{…}` - `FileID string` - `Type File` - `const FileFile File = "file"` - `Type Document` - `const DocumentDocument Document = "document"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` - `Enabled bool` - `Context string` - `Title string` - `type BetaSearchResultBlockParamResp struct{…}` - `Content []BetaTextBlockParamResp` - `Text string` - `Type Text` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnionResp` - `Source string` - `Title string` - `Type SearchResult` - `const SearchResultSearchResult SearchResult = "search_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` - `type BetaThinkingBlockParamResp struct{…}` - `Signature string` - `Thinking string` - `Type Thinking` - `const ThinkingThinking Thinking = "thinking"` - `type BetaRedactedThinkingBlockParamResp struct{…}` - `Data string` - `Type RedactedThinking` - `const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"` - `type BetaToolUseBlockParamResp struct{…}` - `ID string` - `Input map[string, any]` - `Name string` - `Type ToolUse` - `const ToolUseToolUse ToolUse = "tool_use"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Caller BetaToolUseBlockParamCallerUnionResp` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `Type Direct` - `const DirectDirect Direct = "direct"` - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `ToolID string` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `type BetaServerToolCaller20260120 struct{…}` - `ToolID string` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` - `type BetaToolResultBlockParamResp struct{…}` - `ToolUseID string` - `Type ToolResult` - `const ToolResultToolResult ToolResult = "tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Content []BetaToolResultBlockParamContentUnionResp` - `[]BetaToolResultBlockParamContentUnionResp` - `type BetaTextBlockParamResp struct{…}` - `type BetaImageBlockParamResp struct{…}` - `type BetaSearchResultBlockParamResp struct{…}` - `type BetaRequestDocumentBlock struct{…}` - `type BetaToolReferenceBlockParamResp struct{…}` Tool reference block that can be included in tool_result content. - `ToolName string` - `Type ToolReference` - `const ToolReferenceToolReference ToolReference = "tool_reference"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `IsError bool` - `type BetaServerToolUseBlockParamResp struct{…}` - `ID string` - `Input map[string, any]` - `Name BetaServerToolUseBlockParamName` - `const BetaServerToolUseBlockParamNameAdvisor BetaServerToolUseBlockParamName = "advisor"` - `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` - `const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Caller BetaServerToolUseBlockParamCallerUnionResp` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebSearchToolResultBlockParamResp struct{…}` - `Content BetaWebSearchToolResultBlockParamContentUnionResp` - `[]BetaWebSearchResultBlockParamResp` - `EncryptedContent string` - `Title string` - `Type WebSearchResult` - `const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"` - `URL string` - `PageAge string` - `type BetaWebSearchToolRequestError struct{…}` - `ErrorCode BetaWebSearchToolResultErrorCode` - `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` - `const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"` - `ToolUseID string` - `Type WebSearchToolResult` - `const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Caller BetaWebSearchToolResultBlockParamCallerUnionResp` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebFetchToolResultBlockParamResp struct{…}` - `Content BetaWebFetchToolResultBlockParamContentUnionResp` - `type BetaWebFetchToolResultErrorBlockParamResp struct{…}` - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `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` - `const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"` - `type BetaWebFetchBlockParamResp struct{…}` - `Content BetaRequestDocumentBlock` - `Type WebFetchResult` - `const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"` - `URL string` Fetched content URL - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved - `ToolUseID string` - `Type WebFetchToolResult` - `const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Caller BetaWebFetchToolResultBlockParamCallerUnionResp` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaAdvisorToolResultBlockParamResp struct{…}` - `Content BetaAdvisorToolResultBlockParamContentUnionResp` - `type BetaAdvisorToolResultErrorParamResp struct{…}` - `ErrorCode BetaAdvisorToolResultErrorParamErrorCode` - `const BetaAdvisorToolResultErrorParamErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorParamErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorParamErrorCodePromptTooLong BetaAdvisorToolResultErrorParamErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorParamErrorCodeTooManyRequests BetaAdvisorToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorParamErrorCodeOverloaded BetaAdvisorToolResultErrorParamErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorParamErrorCodeUnavailable BetaAdvisorToolResultErrorParamErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorParamErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorParamErrorCode = "execution_time_exceeded"` - `Type AdvisorToolResultError` - `const AdvisorToolResultErrorAdvisorToolResultError AdvisorToolResultError = "advisor_tool_result_error"` - `type BetaAdvisorResultBlockParamResp struct{…}` - `Text string` - `Type AdvisorResult` - `const AdvisorResultAdvisorResult AdvisorResult = "advisor_result"` - `StopReason string` - `type BetaAdvisorRedactedResultBlockParamResp struct{…}` - `EncryptedContent string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `Type AdvisorRedactedResult` - `const AdvisorRedactedResultAdvisorRedactedResult AdvisorRedactedResult = "advisor_redacted_result"` - `StopReason string` - `ToolUseID string` - `Type AdvisorToolResult` - `const AdvisorToolResultAdvisorToolResult AdvisorToolResult = "advisor_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaCodeExecutionToolResultBlockParamResp struct{…}` - `Content BetaCodeExecutionToolResultBlockParamContentUnionResp` Code execution result with encrypted stdout for PFC + web_search results. - `type BetaCodeExecutionToolResultErrorParamResp struct{…}` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `Type CodeExecutionToolResultError` - `const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"` - `type BetaCodeExecutionResultBlockParamResp struct{…}` - `Content []BetaCodeExecutionOutputBlockParamResp` - `FileID string` - `Type CodeExecutionOutput` - `const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type CodeExecutionResult` - `const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"` - `type BetaEncryptedCodeExecutionResultBlockParamResp struct{…}` Code execution result with encrypted stdout for PFC + web_search results. - `Content []BetaCodeExecutionOutputBlockParamResp` - `FileID string` - `Type CodeExecutionOutput` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `Type EncryptedCodeExecutionResult` - `const EncryptedCodeExecutionResultEncryptedCodeExecutionResult EncryptedCodeExecutionResult = "encrypted_code_execution_result"` - `ToolUseID string` - `Type CodeExecutionToolResult` - `const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaBashCodeExecutionToolResultBlockParamResp struct{…}` - `Content BetaBashCodeExecutionToolResultBlockParamContentUnionResp` - `type BetaBashCodeExecutionToolResultErrorParamResp struct{…}` - `ErrorCode BetaBashCodeExecutionToolResultErrorParamErrorCode` - `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` - `const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"` - `type BetaBashCodeExecutionResultBlockParamResp struct{…}` - `Content []BetaBashCodeExecutionOutputBlockParamResp` - `FileID string` - `Type BashCodeExecutionOutput` - `const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type BashCodeExecutionResult` - `const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"` - `ToolUseID string` - `Type BashCodeExecutionToolResult` - `const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaTextEditorCodeExecutionToolResultBlockParamResp struct{…}` - `Content BetaTextEditorCodeExecutionToolResultBlockParamContentUnionResp` - `type BetaTextEditorCodeExecutionToolResultErrorParamResp struct{…}` - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorParamErrorCode` - `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` - `const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"` - `ErrorMessage string` - `type BetaTextEditorCodeExecutionViewResultBlockParamResp struct{…}` - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockParamFileType` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeText BetaTextEditorCodeExecutionViewResultBlockParamFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeImage BetaTextEditorCodeExecutionViewResultBlockParamFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypePDF BetaTextEditorCodeExecutionViewResultBlockParamFileType = "pdf"` - `Type TextEditorCodeExecutionViewResult` - `const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` - `type BetaTextEditorCodeExecutionCreateResultBlockParamResp struct{…}` - `IsFileUpdate bool` - `Type TextEditorCodeExecutionCreateResult` - `const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"` - `type BetaTextEditorCodeExecutionStrReplaceResultBlockParamResp struct{…}` - `Type TextEditorCodeExecutionStrReplaceResult` - `const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"` - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` - `ToolUseID string` - `Type TextEditorCodeExecutionToolResult` - `const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaToolSearchToolResultBlockParamResp struct{…}` - `Content BetaToolSearchToolResultBlockParamContentUnionResp` - `type BetaToolSearchToolResultErrorParamResp struct{…}` - `ErrorCode BetaToolSearchToolResultErrorParamErrorCode` - `const BetaToolSearchToolResultErrorParamErrorCodeInvalidToolInput BetaToolSearchToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaToolSearchToolResultErrorParamErrorCodeUnavailable BetaToolSearchToolResultErrorParamErrorCode = "unavailable"` - `const BetaToolSearchToolResultErrorParamErrorCodeTooManyRequests BetaToolSearchToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaToolSearchToolResultErrorParamErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorParamErrorCode = "execution_time_exceeded"` - `Type ToolSearchToolResultError` - `const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"` - `type BetaToolSearchToolSearchResultBlockParamResp struct{…}` - `ToolReferences []BetaToolReferenceBlockParamResp` - `ToolName string` - `Type ToolReference` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Type ToolSearchToolSearchResult` - `const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"` - `ToolUseID string` - `Type ToolSearchToolResult` - `const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaMCPToolUseBlockParamResp struct{…}` - `ID string` - `Input map[string, any]` - `Name string` - `ServerName string` The name of the MCP server - `Type MCPToolUse` - `const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `type BetaRequestMCPToolResultBlockParamResp struct{…}` - `ToolUseID string` - `Type MCPToolResult` - `const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Content BetaRequestMCPToolResultBlockParamContentUnionResp` - `string` - `[]BetaTextBlockParamResp` - `Text string` - `Type Text` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnionResp` - `IsError bool` - `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` - `const ContainerUploadContainerUpload ContainerUpload = "container_upload"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `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. - `Type Compaction` - `const CompactionCompaction Compaction = "compaction"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Content string` Summary of previously compacted content, or null if compaction failed - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `type BetaMidConversationSystemBlockParamResp struct{…}` System instructions that appear mid-conversation. Use this block to provide or update system-level instructions at a specific point in the conversation, rather than only via the top-level `system` parameter. - `Content []BetaTextBlockParamResp` System instruction text blocks. - `Text string` - `Type Text` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnionResp` - `Type MidConvSystem` - `const MidConvSystemMidConvSystem MidConvSystem = "mid_conv_system"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Role BetaMessageParamRole` - `const BetaMessageParamRoleUser BetaMessageParamRole = "user"` - `const BetaMessageParamRoleAssistant BetaMessageParamRole = "assistant"` - `const BetaMessageParamRoleSystem BetaMessageParamRole = "system"` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type Model string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `const ModelClaudeOpus4_1 Model = "claude-opus-4-1"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_0 Model = "claude-opus-4-0"` Powerful model for complex tasks - `const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"` Powerful model for complex tasks - `const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"` High-performance model with extended thinking - `const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"` High-performance model with extended thinking - `const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"` Fast and cost-effective model - `string` - `CacheControl BetaCacheControlEphemeral` Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request. - `Container BetaMessageBatchNewParamsRequestParamsContainerUnion` Container identifier for reuse across requests. - `type BetaContainerParamsResp struct{…}` Container parameters with skills to be loaded. - `ID string` Container id - `Skills []BetaSkillParamsResp` List of skills to load in the container - `SkillID string` Skill ID - `Type BetaSkillParamsType` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `const BetaSkillParamsTypeAnthropic BetaSkillParamsType = "anthropic"` - `const BetaSkillParamsTypeCustom BetaSkillParamsType = "custom"` - `Version string` Skill version or 'latest' for most recent version - `string` - `ContextManagement BetaContextManagementConfig` Context management configuration. This allows you to control how Claude manages context across multiple requests, such as whether to clear function results or not. - `Edits []BetaContextManagementConfigEditUnion` List of context management edits to apply - `type BetaClearToolUses20250919Edit struct{…}` - `Type ClearToolUses20250919` - `const ClearToolUses20250919ClearToolUses20250919 ClearToolUses20250919 = "clear_tool_uses_20250919"` - `ClearAtLeast BetaInputTokensClearAtLeast` Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed. - `Type InputTokens` - `const InputTokensInputTokens InputTokens = "input_tokens"` - `Value int64` - `ClearToolInputs BetaClearToolUses20250919EditClearToolInputsUnion` Whether to clear all tool inputs (bool) or specific tool inputs to clear (list) - `bool` - `[]string` - `ExcludeTools []string` Tool names whose uses are preserved from clearing - `Keep BetaToolUsesKeep` Number of tool uses to retain in the conversation - `Type ToolUses` - `const ToolUsesToolUses ToolUses = "tool_uses"` - `Value int64` - `Trigger BetaClearToolUses20250919EditTriggerUnion` Condition that triggers the context management strategy - `type BetaInputTokensTrigger struct{…}` - `Type InputTokens` - `const InputTokensInputTokens InputTokens = "input_tokens"` - `Value int64` - `type BetaToolUsesTrigger struct{…}` - `Type ToolUses` - `const ToolUsesToolUses ToolUses = "tool_uses"` - `Value int64` - `type BetaClearThinking20251015Edit struct{…}` - `Type ClearThinking20251015` - `const ClearThinking20251015ClearThinking20251015 ClearThinking20251015 = "clear_thinking_20251015"` - `Keep BetaClearThinking20251015EditKeepUnion` Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed. - `type BetaThinkingTurns struct{…}` - `Type ThinkingTurns` - `const ThinkingTurnsThinkingTurns ThinkingTurns = "thinking_turns"` - `Value int64` - `type BetaAllThinkingTurns struct{…}` - `Type All` - `const AllAll All = "all"` - `All` - `const AllAll All = "all"` - `type BetaCompact20260112Edit struct{…}` Automatically compact older context when reaching the configured trigger threshold. - `Type Compact20260112` - `const Compact20260112Compact20260112 Compact20260112 = "compact_20260112"` - `Instructions string` Additional instructions for summarization. - `PauseAfterCompaction bool` Whether to pause after compaction and return the compaction block to the user. - `Trigger BetaInputTokensTrigger` When to trigger compaction. Defaults to 150000 input tokens. - `Diagnostics BetaDiagnosticsParamResp` Request-level diagnostics. Currently carries the previous response id for prompt-cache divergence reporting. - `PreviousMessageID string` The `id` (`msg_...`) from this client's previous /v1/messages response. The server compares that request's prompt fingerprint against this one and returns `diagnostics.cache_miss_reason` when the prompt-cache prefix could not be reused. Pass `null` on the first turn to opt in without a prior message to compare. - `InferenceGeo string` Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used. - `MCPServers []BetaRequestMCPServerURLDefinition` MCP servers to be utilized in this request - `Name string` - `Type URL` - `const URLURL URL = "url"` - `URL string` - `AuthorizationToken string` - `ToolConfiguration BetaRequestMCPServerToolConfiguration` - `AllowedTools []string` - `Enabled bool` - `Metadata BetaMetadata` An object describing metadata about the request. - `UserID string` An external identifier for the user who is associated with the request. This should be a uuid, hash value, or other opaque identifier. Anthropic may use this id to help detect abuse. Do not include any identifying information such as name, email address, or phone number. - `OutputConfig BetaOutputConfig` Configuration options for the model's output, such as the output format. - `Effort BetaOutputConfigEffort` All possible effort levels. - `const BetaOutputConfigEffortLow BetaOutputConfigEffort = "low"` - `const BetaOutputConfigEffortMedium BetaOutputConfigEffort = "medium"` - `const BetaOutputConfigEffortHigh BetaOutputConfigEffort = "high"` - `const BetaOutputConfigEffortXhigh BetaOutputConfigEffort = "xhigh"` - `const BetaOutputConfigEffortMax BetaOutputConfigEffort = "max"` - `Format BetaJSONOutputFormat` A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) - `Schema map[string, any]` The JSON schema of the format - `Type JSONSchema` - `const JSONSchemaJSONSchema JSONSchema = "json_schema"` - `TaskBudget BetaTokenTaskBudget` User-configurable total token budget across contexts. - `Total int64` Total token budget across all contexts in the session. - `Type Tokens` The budget type. Currently only 'tokens' is supported. - `const TokensTokens Tokens = "tokens"` - `Remaining int64` Remaining tokens in the budget. Use this to track usage across contexts when implementing compaction client-side. Defaults to total if not provided. - `OutputFormat BetaJSONOutputFormat` Deprecated: Use `output_config.format` instead. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) A schema to specify Claude's output format in responses. This parameter will be removed in a future release. - `ServiceTier string` Determines whether to use priority capacity (if available) or standard capacity for this request. Anthropic offers different levels of service for your API requests. See [service-tiers](https://docs.claude.com/en/api/service-tiers) for details. - `const BetaMessageBatchNewParamsRequestParamsServiceTierAuto BetaMessageBatchNewParamsRequestParamsServiceTier = "auto"` - `const BetaMessageBatchNewParamsRequestParamsServiceTierStandardOnly BetaMessageBatchNewParamsRequestParamsServiceTier = "standard_only"` - `Speed string` The inference speed mode for this request. `"fast"` enables high output-tokens-per-second inference. - `const BetaMessageBatchNewParamsRequestParamsSpeedStandard BetaMessageBatchNewParamsRequestParamsSpeed = "standard"` - `const BetaMessageBatchNewParamsRequestParamsSpeedFast BetaMessageBatchNewParamsRequestParamsSpeed = "fast"` - `StopSequences []string` Custom text sequences that will cause the model to stop generating. Our models will normally stop when they have naturally completed their turn, which will result in a response `stop_reason` of `"end_turn"`. If you want the model to stop generating when it encounters custom strings of text, you can use the `stop_sequences` parameter. If the model encounters one of the custom sequences, the response `stop_reason` value will be `"stop_sequence"` and the response `stop_sequence` value will contain the matched stop sequence. - `Stream bool` Whether to incrementally stream the response using server-sent events. See [streaming](https://docs.claude.com/en/api/messages-streaming) for details. - `System []BetaTextBlockParamResp` System prompt. A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://docs.claude.com/en/docs/system-prompts). - `[]BetaTextBlockParam` - `Text string` - `Type Text` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnionResp` - `Temperature float64` Amount of randomness injected into the response. Defaults to `1.0`. Ranges from `0.0` to `1.0`. Use `temperature` closer to `0.0` for analytical / multiple choice, and closer to `1.0` for creative and generative tasks. Note that even with `temperature` of `0.0`, the results will not be fully deterministic. - `Thinking BetaThinkingConfigParamUnionResp` Configuration for enabling Claude's extended thinking. When enabled, responses include `thinking` content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your `max_tokens` limit. See [extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details. - `type BetaThinkingConfigEnabled struct{…}` - `BudgetTokens int64` Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality. Must be ≥1024 and less than `max_tokens`. See [extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details. - `Type Enabled` - `const EnabledEnabled Enabled = "enabled"` - `Display BetaThinkingConfigEnabledDisplay` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. - `const BetaThinkingConfigEnabledDisplaySummarized BetaThinkingConfigEnabledDisplay = "summarized"` - `const BetaThinkingConfigEnabledDisplayOmitted BetaThinkingConfigEnabledDisplay = "omitted"` - `type BetaThinkingConfigDisabled struct{…}` - `Type Disabled` - `const DisabledDisabled Disabled = "disabled"` - `type BetaThinkingConfigAdaptive struct{…}` - `Type Adaptive` - `const AdaptiveAdaptive Adaptive = "adaptive"` - `Display BetaThinkingConfigAdaptiveDisplay` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. - `const BetaThinkingConfigAdaptiveDisplaySummarized BetaThinkingConfigAdaptiveDisplay = "summarized"` - `const BetaThinkingConfigAdaptiveDisplayOmitted BetaThinkingConfigAdaptiveDisplay = "omitted"` - `ToolChoice BetaToolChoiceUnion` How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. - `type BetaToolChoiceAuto struct{…}` The model will automatically decide whether to use tools. - `Type Auto` - `const AutoAuto Auto = "auto"` - `DisableParallelToolUse bool` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output at most one tool use. - `type BetaToolChoiceAny struct{…}` The model will use any available tools. - `Type Any` - `const AnyAny Any = "any"` - `DisableParallelToolUse bool` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `type BetaToolChoiceTool struct{…}` The model will use the specified tool with `tool_choice.name`. - `Name string` The name of the tool to use. - `Type Tool` - `const ToolTool Tool = "tool"` - `DisableParallelToolUse bool` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `type BetaToolChoiceNone struct{…}` The model will not be allowed to use tools. - `Type None` - `const NoneNone None = "none"` - `Tools []BetaToolUnion` Definitions of tools that the model may use. If you include `tools` in your API request, the model may return `tool_use` content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using `tool_result` content blocks. There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://docs.claude.com/en/docs/agents-and-tools/tool-use/overview#server-tools), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://docs.claude.com/en/docs/agents-and-tools/tool-use/web-search-tool)). Each tool definition includes: * `name`: Name of the tool. * `description`: Optional, but strongly-recommended description of the tool. * `input_schema`: [JSON schema](https://json-schema.org/draft/2020-12) for the tool `input` shape that the model will produce in `tool_use` output content blocks. For example, if you defined `tools` as: ```json [ { "name": "get_stock_price", "description": "Get the current stock price for a given ticker symbol.", "input_schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "The stock ticker symbol, e.g. AAPL for Apple Inc." } }, "required": ["ticker"] } } ] ``` And then asked the model "What's the S&P 500 at today?", the model might produce `tool_use` content blocks in the response like this: ```json [ { "type": "tool_use", "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "name": "get_stock_price", "input": { "ticker": "^GSPC" } } ] ``` You might then run your `get_stock_price` tool with `{"ticker": "^GSPC"}` as an input, and return the following back to the model in a subsequent `user` message: ```json [ { "type": "tool_result", "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "content": "259.75 USD" } ] ``` Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output. See our [guide](https://docs.claude.com/en/docs/tool-use) for more details. - `type BetaTool struct{…}` - `InputSchema BetaToolInputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `const ObjectObject Object = "object"` - `Properties map[string, any]` - `Required []string` - `Name string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string` - `const BetaToolAllowedCallerDirect BetaToolAllowedCaller = "direct"` - `const BetaToolAllowedCallerCodeExecution20250825 BetaToolAllowedCaller = "code_execution_20250825"` - `const BetaToolAllowedCallerCodeExecution20260120 BetaToolAllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Description string` Description of what this tool does. Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema. - `EagerInputStreaming bool` Enable eager input streaming for this tool. When true, tool input parameters will be streamed incrementally as they are generated, and types will be inferred on-the-fly rather than buffering the full JSON output. When false, streaming is disabled for this tool even if the fine-grained-tool-streaming beta is active. When null (default), uses the default behavior based on beta headers. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `Type BetaToolType` - `const BetaToolTypeCustom BetaToolType = "custom"` - `type BetaToolBash20241022 struct{…}` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const BashBash Bash = "bash"` - `Type Bash20241022` - `const Bash20241022Bash20241022 Bash20241022 = "bash_20241022"` - `AllowedCallers []string` - `const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"` - `const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260120 BetaToolBash20241022AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20250124 struct{…}` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const BashBash Bash = "bash"` - `Type Bash20250124` - `const Bash20250124Bash20250124 Bash20250124 = "bash_20250124"` - `AllowedCallers []string` - `const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"` - `const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260120 BetaToolBash20250124AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250522 struct{…}` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const CodeExecutionCodeExecution CodeExecution = "code_execution"` - `Type CodeExecution20250522` - `const CodeExecution20250522CodeExecution20250522 CodeExecution20250522 = "code_execution_20250522"` - `AllowedCallers []string` - `const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250825 struct{…}` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const CodeExecutionCodeExecution CodeExecution = "code_execution"` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `AllowedCallers []string` - `const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260120 struct{…}` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const CodeExecutionCodeExecution CodeExecution = "code_execution"` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` - `AllowedCallers []string` - `const BetaCodeExecutionTool20260120AllowedCallerDirect BetaCodeExecutionTool20260120AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20241022 struct{…}` - `DisplayHeightPx int64` The height of the display in pixels. - `DisplayWidthPx int64` The width of the display in pixels. - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const ComputerComputer Computer = "computer"` - `Type Computer20241022` - `const Computer20241022Computer20241022 Computer20241022 = "computer_20241022"` - `AllowedCallers []string` - `const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260120 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64` The X11 display number (e.g. 0, 1) for the display. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaMemoryTool20250818 struct{…}` - `Name Memory` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const MemoryMemory Memory = "memory"` - `Type Memory20250818` - `const Memory20250818Memory20250818 Memory20250818 = "memory_20250818"` - `AllowedCallers []string` - `const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260120 BetaMemoryTool20250818AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20250124 struct{…}` - `DisplayHeightPx int64` The height of the display in pixels. - `DisplayWidthPx int64` The width of the display in pixels. - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const ComputerComputer Computer = "computer"` - `Type Computer20250124` - `const Computer20250124Computer20250124 Computer20250124 = "computer_20250124"` - `AllowedCallers []string` - `const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260120 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64` The X11 display number (e.g. 0, 1) for the display. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20241022 struct{…}` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const StrReplaceEditorStrReplaceEditor StrReplaceEditor = "str_replace_editor"` - `Type TextEditor20241022` - `const TextEditor20241022TextEditor20241022 TextEditor20241022 = "text_editor_20241022"` - `AllowedCallers []string` - `const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260120 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20251124 struct{…}` - `DisplayHeightPx int64` The height of the display in pixels. - `DisplayWidthPx int64` The width of the display in pixels. - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const ComputerComputer Computer = "computer"` - `Type Computer20251124` - `const Computer20251124Computer20251124 Computer20251124 = "computer_20251124"` - `AllowedCallers []string` - `const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260120 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64` The X11 display number (e.g. 0, 1) for the display. - `EnableZoom bool` Whether to enable an action to take a zoomed-in screenshot of the screen. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250124 struct{…}` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const StrReplaceEditorStrReplaceEditor StrReplaceEditor = "str_replace_editor"` - `Type TextEditor20250124` - `const TextEditor20250124TextEditor20250124 TextEditor20250124 = "text_editor_20250124"` - `AllowedCallers []string` - `const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260120 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250429 struct{…}` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const StrReplaceBasedEditToolStrReplaceBasedEditTool StrReplaceBasedEditTool = "str_replace_based_edit_tool"` - `Type TextEditor20250429` - `const TextEditor20250429TextEditor20250429 TextEditor20250429 = "text_editor_20250429"` - `AllowedCallers []string` - `const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260120 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250728 struct{…}` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const StrReplaceBasedEditToolStrReplaceBasedEditTool StrReplaceBasedEditTool = "str_replace_based_edit_tool"` - `Type TextEditor20250728` - `const TextEditor20250728TextEditor20250728 TextEditor20250728 = "text_editor_20250728"` - `AllowedCallers []string` - `const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260120 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any]` - `MaxCharacters int64` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20250305 struct{…}` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const WebSearchWebSearch WebSearch = "web_search"` - `Type WebSearch20250305` - `const WebSearch20250305WebSearch20250305 WebSearch20250305 = "web_search_20250305"` - `AllowedCallers []string` - `const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260120 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260120"` - `AllowedDomains []string` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `const ApproximateApproximate Approximate = "approximate"` - `City string` The city of the user. - `Country string` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. - `Region string` The region of the user. - `Timezone string` The [IANA timezone](https://nodatime.org/TimeZones) of the user. - `type BetaWebFetchTool20250910 struct{…}` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const WebFetchWebFetch WebFetch = "web_fetch"` - `Type WebFetch20250910` - `const WebFetch20250910WebFetch20250910 WebFetch20250910 = "web_fetch_20250910"` - `AllowedCallers []string` - `const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260120 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260120"` - `AllowedDomains []string` List of domains to allow fetching from - `BlockedDomains []string` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20260209 struct{…}` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const WebSearchWebSearch WebSearch = "web_search"` - `Type WebSearch20260209` - `const WebSearch20260209WebSearch20260209 WebSearch20260209 = "web_search_20260209"` - `AllowedCallers []string` - `const BetaWebSearchTool20260209AllowedCallerDirect BetaWebSearchTool20260209AllowedCaller = "direct"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20250825 BetaWebSearchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260120 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260120"` - `AllowedDomains []string` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260209 struct{…}` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const WebFetchWebFetch WebFetch = "web_fetch"` - `Type WebFetch20260209` - `const WebFetch20260209WebFetch20260209 WebFetch20260209 = "web_fetch_20260209"` - `AllowedCallers []string` - `const BetaWebFetchTool20260209AllowedCallerDirect BetaWebFetchTool20260209AllowedCaller = "direct"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20250825 BetaWebFetchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260120 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260120"` - `AllowedDomains []string` List of domains to allow fetching from - `BlockedDomains []string` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaWebFetchTool20260309 struct{…}` Web fetch tool with use_cache parameter for bypassing cached content. - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const WebFetchWebFetch WebFetch = "web_fetch"` - `Type WebFetch20260309` - `const WebFetch20260309WebFetch20260309 WebFetch20260309 = "web_fetch_20260309"` - `AllowedCallers []string` - `const BetaWebFetchTool20260309AllowedCallerDirect BetaWebFetchTool20260309AllowedCaller = "direct"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20250825 BetaWebFetchTool20260309AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260120 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260120"` - `AllowedDomains []string` List of domains to allow fetching from - `BlockedDomains []string` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `UseCache bool` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaAdvisorTool20260301 struct{…}` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `Name Advisor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const AdvisorAdvisor Advisor = "advisor"` - `Type Advisor20260301` - `const Advisor20260301Advisor20260301 Advisor20260301 = "advisor_20260301"` - `AllowedCallers []string` - `const BetaAdvisorTool20260301AllowedCallerDirect BetaAdvisorTool20260301AllowedCaller = "direct"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20250825 BetaAdvisorTool20260301AllowedCaller = "code_execution_20250825"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260120 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Caching BetaCacheControlEphemeral` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64` Maximum number of times the tool can be used in the API request. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolBm25_20251119 struct{…}` - `Name ToolSearchToolBm25` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const ToolSearchToolBm25ToolSearchToolBm25 ToolSearchToolBm25 = "tool_search_tool_bm25"` - `Type BetaToolSearchToolBm25_20251119Type` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"` - `AllowedCallers []string` - `const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolRegex20251119 struct{…}` - `Name ToolSearchToolRegex` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `const ToolSearchToolRegexToolSearchToolRegex ToolSearchToolRegex = "tool_search_tool_regex"` - `Type BetaToolSearchToolRegex20251119Type` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"` - `AllowedCallers []string` - `const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260120"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `DeferLoading bool` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool` When true, guarantees schema validation on tool names and inputs - `type BetaMCPToolset struct{…}` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `MCPServerName string` Name of the MCP server to configure tools for - `Type MCPToolset` - `const MCPToolsetMCPToolset MCPToolset = "mcp_toolset"` - `CacheControl BetaCacheControlEphemeral` Create a cache control breakpoint at this content block. - `Configs map[string, BetaMCPToolConfig]` Configuration overrides for specific tools, keyed by tool name - `DeferLoading bool` - `Enabled bool` - `DefaultConfig BetaMCPToolDefaultConfig` Default configuration applied to all tools from this server - `DeferLoading bool` - `Enabled bool` - `TopK int64` Only sample from the top K options for each subsequent token. Used to remove "long tail" low probability responses. [Learn more technical details here](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277). Recommended for advanced use cases only. - `TopP float64` Use nucleus sampling. In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by `top_p`. Recommended for advanced use cases only. - `UserProfileID string` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaMessageBatch struct{…}` - `ID string` Unique object identifier. The format and length of IDs may change over time. - `ArchivedAt Time` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. - `CancelInitiatedAt Time` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. - `CreatedAt Time` RFC 3339 datetime string representing the time at which the Message Batch was created. - `EndedAt Time` RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends. Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired. - `ExpiresAt Time` RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. - `ProcessingStatus BetaMessageBatchProcessingStatus` Processing status of the Message Batch. - `const BetaMessageBatchProcessingStatusInProgress BetaMessageBatchProcessingStatus = "in_progress"` - `const BetaMessageBatchProcessingStatusCanceling BetaMessageBatchProcessingStatus = "canceling"` - `const BetaMessageBatchProcessingStatusEnded BetaMessageBatchProcessingStatus = "ended"` - `RequestCounts BetaMessageBatchRequestCounts` Tallies requests within the Message Batch, categorized by their status. Requests start as `processing` and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch. - `Canceled int64` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. - `Errored int64` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. - `Expired int64` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. - `Processing int64` Number of requests in the Message Batch that are processing. - `Succeeded int64` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. - `ResultsURL string` URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. - `Type MessageBatch` Object type. For Message Batches, this is always `"message_batch"`. - `const MessageBatchMessageBatch MessageBatch = "message_batch"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaMessageBatch, err := client.Beta.Messages.Batches.New(context.TODO(), anthropic.BetaMessageBatchNewParams{ Requests: []anthropic.BetaMessageBatchNewParamsRequest{anthropic.BetaMessageBatchNewParamsRequest{ CustomID: "my-custom-id-1", Params: anthropic.BetaMessageBatchNewParamsRequestParams{ MaxTokens: 1024, Messages: []anthropic.BetaMessageParam{anthropic.BetaMessageParam{ Content: []anthropic.BetaContentBlockParamUnion{anthropic.BetaContentBlockParamUnion{ OfText: &anthropic.BetaTextBlockParam{ Text: "x", }, }}, Role: anthropic.BetaMessageParamRoleUser, }}, Model: anthropic.ModelClaudeOpus4_6, }, }}, }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaMessageBatch.ID) } ``` #### Response ```json { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } ``` ## Retrieve a Message Batch `client.Beta.Messages.Batches.Get(ctx, messageBatchID, query) (*BetaMessageBatch, error)` **get** `/v1/messages/batches/{message_batch_id}` This endpoint is idempotent and can be used to poll for Message Batch completion. To access the results of a Message Batch, make a request to the `results_url` field in the response. Learn more about the Message Batches API in our [user guide](https://docs.claude.com/en/docs/build-with-claude/batch-processing) ### Parameters - `messageBatchID string` ID of the Message Batch. - `query BetaMessageBatchGetParams` - `Betas param.Field[[]AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaMessageBatch struct{…}` - `ID string` Unique object identifier. The format and length of IDs may change over time. - `ArchivedAt Time` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. - `CancelInitiatedAt Time` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. - `CreatedAt Time` RFC 3339 datetime string representing the time at which the Message Batch was created. - `EndedAt Time` RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends. Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired. - `ExpiresAt Time` RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. - `ProcessingStatus BetaMessageBatchProcessingStatus` Processing status of the Message Batch. - `const BetaMessageBatchProcessingStatusInProgress BetaMessageBatchProcessingStatus = "in_progress"` - `const BetaMessageBatchProcessingStatusCanceling BetaMessageBatchProcessingStatus = "canceling"` - `const BetaMessageBatchProcessingStatusEnded BetaMessageBatchProcessingStatus = "ended"` - `RequestCounts BetaMessageBatchRequestCounts` Tallies requests within the Message Batch, categorized by their status. Requests start as `processing` and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch. - `Canceled int64` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. - `Errored int64` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. - `Expired int64` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. - `Processing int64` Number of requests in the Message Batch that are processing. - `Succeeded int64` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. - `ResultsURL string` URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. - `Type MessageBatch` Object type. For Message Batches, this is always `"message_batch"`. - `const MessageBatchMessageBatch MessageBatch = "message_batch"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaMessageBatch, err := client.Beta.Messages.Batches.Get( context.TODO(), "message_batch_id", anthropic.BetaMessageBatchGetParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaMessageBatch.ID) } ``` #### Response ```json { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } ``` ## List Message Batches `client.Beta.Messages.Batches.List(ctx, params) (*Page[BetaMessageBatch], error)` **get** `/v1/messages/batches` List all Message Batches within a Workspace. Most recently created batches are returned first. Learn more about the Message Batches API in our [user guide](https://docs.claude.com/en/docs/build-with-claude/batch-processing) ### Parameters - `params BetaMessageBatchListParams` - `AfterID param.Field[string]` Query param: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. - `BeforeID param.Field[string]` Query param: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. - `Limit param.Field[int64]` Query param: Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaMessageBatch struct{…}` - `ID string` Unique object identifier. The format and length of IDs may change over time. - `ArchivedAt Time` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. - `CancelInitiatedAt Time` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. - `CreatedAt Time` RFC 3339 datetime string representing the time at which the Message Batch was created. - `EndedAt Time` RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends. Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired. - `ExpiresAt Time` RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. - `ProcessingStatus BetaMessageBatchProcessingStatus` Processing status of the Message Batch. - `const BetaMessageBatchProcessingStatusInProgress BetaMessageBatchProcessingStatus = "in_progress"` - `const BetaMessageBatchProcessingStatusCanceling BetaMessageBatchProcessingStatus = "canceling"` - `const BetaMessageBatchProcessingStatusEnded BetaMessageBatchProcessingStatus = "ended"` - `RequestCounts BetaMessageBatchRequestCounts` Tallies requests within the Message Batch, categorized by their status. Requests start as `processing` and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch. - `Canceled int64` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. - `Errored int64` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. - `Expired int64` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. - `Processing int64` Number of requests in the Message Batch that are processing. - `Succeeded int64` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. - `ResultsURL string` URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. - `Type MessageBatch` Object type. For Message Batches, this is always `"message_batch"`. - `const MessageBatchMessageBatch MessageBatch = "message_batch"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) page, err := client.Beta.Messages.Batches.List(context.TODO(), anthropic.BetaMessageBatchListParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "data": [ { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } ], "first_id": "first_id", "has_more": true, "last_id": "last_id" } ``` ## Cancel a Message Batch `client.Beta.Messages.Batches.Cancel(ctx, messageBatchID, body) (*BetaMessageBatch, error)` **post** `/v1/messages/batches/{message_batch_id}/cancel` Batches may be canceled any time before processing ends. Once cancellation is initiated, the batch enters a `canceling` state, at which time the system may complete any in-progress, non-interruptible requests before finalizing cancellation. The number of canceled requests is specified in `request_counts`. To determine which requests were canceled, check the individual results within the batch. Note that cancellation may not result in any canceled requests if they were non-interruptible. Learn more about the Message Batches API in our [user guide](https://docs.claude.com/en/docs/build-with-claude/batch-processing) ### Parameters - `messageBatchID string` ID of the Message Batch. - `body BetaMessageBatchCancelParams` - `Betas param.Field[[]AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaMessageBatch struct{…}` - `ID string` Unique object identifier. The format and length of IDs may change over time. - `ArchivedAt Time` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. - `CancelInitiatedAt Time` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. - `CreatedAt Time` RFC 3339 datetime string representing the time at which the Message Batch was created. - `EndedAt Time` RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends. Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired. - `ExpiresAt Time` RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. - `ProcessingStatus BetaMessageBatchProcessingStatus` Processing status of the Message Batch. - `const BetaMessageBatchProcessingStatusInProgress BetaMessageBatchProcessingStatus = "in_progress"` - `const BetaMessageBatchProcessingStatusCanceling BetaMessageBatchProcessingStatus = "canceling"` - `const BetaMessageBatchProcessingStatusEnded BetaMessageBatchProcessingStatus = "ended"` - `RequestCounts BetaMessageBatchRequestCounts` Tallies requests within the Message Batch, categorized by their status. Requests start as `processing` and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch. - `Canceled int64` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. - `Errored int64` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. - `Expired int64` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. - `Processing int64` Number of requests in the Message Batch that are processing. - `Succeeded int64` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. - `ResultsURL string` URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. - `Type MessageBatch` Object type. For Message Batches, this is always `"message_batch"`. - `const MessageBatchMessageBatch MessageBatch = "message_batch"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaMessageBatch, err := client.Beta.Messages.Batches.Cancel( context.TODO(), "message_batch_id", anthropic.BetaMessageBatchCancelParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaMessageBatch.ID) } ``` #### Response ```json { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } ``` ## Delete a Message Batch `client.Beta.Messages.Batches.Delete(ctx, messageBatchID, body) (*BetaDeletedMessageBatch, error)` **delete** `/v1/messages/batches/{message_batch_id}` Delete a Message Batch. Message Batches can only be deleted once they've finished processing. If you'd like to delete an in-progress batch, you must first cancel it. Learn more about the Message Batches API in our [user guide](https://docs.claude.com/en/docs/build-with-claude/batch-processing) ### Parameters - `messageBatchID string` ID of the Message Batch. - `body BetaMessageBatchDeleteParams` - `Betas param.Field[[]AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaDeletedMessageBatch struct{…}` - `ID string` ID of the Message Batch. - `Type MessageBatchDeleted` Deleted object type. For Message Batches, this is always `"message_batch_deleted"`. - `const MessageBatchDeletedMessageBatchDeleted MessageBatchDeleted = "message_batch_deleted"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaDeletedMessageBatch, err := client.Beta.Messages.Batches.Delete( context.TODO(), "message_batch_id", anthropic.BetaMessageBatchDeleteParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaDeletedMessageBatch.ID) } ``` #### Response ```json { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "type": "message_batch_deleted" } ``` ## Retrieve Message Batch results `client.Beta.Messages.Batches.Results(ctx, messageBatchID, query) (*BetaMessageBatchIndividualResponse, error)` **get** `/v1/messages/batches/{message_batch_id}/results` Streams the results of a Message Batch as a `.jsonl` file. Each line in the file is a JSON object containing the result of a single request in the Message Batch. Results are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. Learn more about the Message Batches API in our [user guide](https://docs.claude.com/en/docs/build-with-claude/batch-processing) ### Parameters - `messageBatchID string` ID of the Message Batch. - `query BetaMessageBatchResultsParams` - `Betas param.Field[[]AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaMessageBatchIndividualResponse struct{…}` This is a single line in the response `.jsonl` file and does not represent the response as a whole. - `CustomID string` Developer-provided ID created for each request in a Message Batch. Useful for matching results to requests, as results may be given out of request order. Must be unique for each request within the Message Batch. - `Result BetaMessageBatchResultUnion` Processing result for this request. Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration. - `type BetaMessageBatchSucceededResult struct{…}` - `Message BetaMessage` - `ID string` Unique object identifier. The format and length of IDs may change over time. - `Container BetaContainer` Information about the container used in the request (for the code execution tool) - `ID string` Identifier for the container used in this request - `ExpiresAt Time` The time at which the container will expire. - `Skills []BetaSkill` Skills loaded in the container - `SkillID string` Skill ID - `Type BetaSkillType` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `const BetaSkillTypeAnthropic BetaSkillType = "anthropic"` - `const BetaSkillTypeCustom BetaSkillType = "custom"` - `Version string` Skill version or 'latest' for most recent version - `Content []BetaContentBlockUnion` Content generated by the model. This is an array of content blocks, each of which has a `type` that determines its shape. Example: ```json [{"type": "text", "text": "Hi, I'm Claude."}] ``` If the request input `messages` ended with an `assistant` turn, then the response `content` will continue directly from that last turn. You can use this to constrain the model's output. For example, if the input `messages` were: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("} ] ``` Then the response `content` might be: ```json [{"type": "text", "text": "B)"}] ``` - `type BetaTextBlock struct{…}` - `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`. - `type BetaCitationCharLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationsWebSearchResultLocation struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `Text string` - `Type Text` - `const TextText Text = "text"` - `type BetaThinkingBlock struct{…}` - `Signature string` - `Thinking string` - `Type Thinking` - `const ThinkingThinking Thinking = "thinking"` - `type BetaRedactedThinkingBlock struct{…}` - `Data string` - `Type RedactedThinking` - `const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"` - `type BetaToolUseBlock struct{…}` - `ID string` - `Input map[string, any]` - `Name string` - `Type ToolUse` - `const ToolUseToolUse ToolUse = "tool_use"` - `Caller BetaToolUseBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `Type Direct` - `const DirectDirect Direct = "direct"` - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `ToolID string` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `type BetaServerToolCaller20260120 struct{…}` - `ToolID string` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` - `type BetaServerToolUseBlock struct{…}` - `ID string` - `Input map[string, any]` - `Name BetaServerToolUseBlockName` - `const BetaServerToolUseBlockNameAdvisor BetaServerToolUseBlockName = "advisor"` - `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` - `const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"` - `Caller BetaServerToolUseBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebSearchToolResultBlock struct{…}` - `Content BetaWebSearchToolResultBlockContentUnion` - `type BetaWebSearchToolResultError struct{…}` - `ErrorCode BetaWebSearchToolResultErrorCode` - `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` - `const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"` - `type BetaWebSearchToolResultBlockContentArray []BetaWebSearchResultBlock` - `EncryptedContent string` - `PageAge string` - `Title string` - `Type WebSearchResult` - `const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"` - `URL string` - `ToolUseID string` - `Type WebSearchToolResult` - `const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"` - `Caller BetaWebSearchToolResultBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebFetchToolResultBlock struct{…}` - `Content BetaWebFetchToolResultBlockContentUnion` - `type BetaWebFetchToolResultErrorBlock struct{…}` - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `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` - `const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"` - `type BetaWebFetchBlock struct{…}` - `Content BetaDocumentBlock` - `Citations BetaCitationConfig` Citation configuration for the document - `Enabled bool` - `Source BetaDocumentBlockSourceUnion` - `type BetaBase64PDFSource struct{…}` - `Data string` - `MediaType ApplicationPDF` - `const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaPlainTextSource struct{…}` - `Data string` - `MediaType TextPlain` - `const TextPlainTextPlain TextPlain = "text/plain"` - `Type Text` - `const TextText Text = "text"` - `Title string` The title of the document - `Type Document` - `const DocumentDocument Document = "document"` - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved - `Type WebFetchResult` - `const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"` - `URL string` Fetched content URL - `ToolUseID string` - `Type WebFetchToolResult` - `const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"` - `Caller BetaWebFetchToolResultBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaAdvisorToolResultBlock struct{…}` - `Content BetaAdvisorToolResultBlockContentUnion` - `type BetaAdvisorToolResultError struct{…}` - `ErrorCode BetaAdvisorToolResultErrorErrorCode` - `const BetaAdvisorToolResultErrorErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodePromptTooLong BetaAdvisorToolResultErrorErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorErrorCodeTooManyRequests BetaAdvisorToolResultErrorErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorErrorCodeOverloaded BetaAdvisorToolResultErrorErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorErrorCodeUnavailable BetaAdvisorToolResultErrorErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorErrorCode = "execution_time_exceeded"` - `Type AdvisorToolResultError` - `const AdvisorToolResultErrorAdvisorToolResultError AdvisorToolResultError = "advisor_tool_result_error"` - `type BetaAdvisorResultBlock struct{…}` - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `Text string` - `Type AdvisorResult` - `const AdvisorResultAdvisorResult AdvisorResult = "advisor_result"` - `type BetaAdvisorRedactedResultBlock struct{…}` - `EncryptedContent string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `Type AdvisorRedactedResult` - `const AdvisorRedactedResultAdvisorRedactedResult AdvisorRedactedResult = "advisor_redacted_result"` - `ToolUseID string` - `Type AdvisorToolResult` - `const AdvisorToolResultAdvisorToolResult AdvisorToolResult = "advisor_tool_result"` - `type BetaCodeExecutionToolResultBlock struct{…}` - `Content BetaCodeExecutionToolResultBlockContentUnion` Code execution result with encrypted stdout for PFC + web_search results. - `type BetaCodeExecutionToolResultError struct{…}` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `Type CodeExecutionToolResultError` - `const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"` - `type BetaCodeExecutionResultBlock struct{…}` - `Content []BetaCodeExecutionOutputBlock` - `FileID string` - `Type CodeExecutionOutput` - `const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type CodeExecutionResult` - `const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"` - `type BetaEncryptedCodeExecutionResultBlock struct{…}` Code execution result with encrypted stdout for PFC + web_search results. - `Content []BetaCodeExecutionOutputBlock` - `FileID string` - `Type CodeExecutionOutput` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `Type EncryptedCodeExecutionResult` - `const EncryptedCodeExecutionResultEncryptedCodeExecutionResult EncryptedCodeExecutionResult = "encrypted_code_execution_result"` - `ToolUseID string` - `Type CodeExecutionToolResult` - `const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"` - `type BetaBashCodeExecutionToolResultBlock struct{…}` - `Content BetaBashCodeExecutionToolResultBlockContentUnion` - `type BetaBashCodeExecutionToolResultError struct{…}` - `ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode` - `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` - `const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"` - `type BetaBashCodeExecutionResultBlock struct{…}` - `Content []BetaBashCodeExecutionOutputBlock` - `FileID string` - `Type BashCodeExecutionOutput` - `const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type BashCodeExecutionResult` - `const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"` - `ToolUseID string` - `Type BashCodeExecutionToolResult` - `const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"` - `type BetaTextEditorCodeExecutionToolResultBlock struct{…}` - `Content BetaTextEditorCodeExecutionToolResultBlockContentUnion` - `type BetaTextEditorCodeExecutionToolResultError struct{…}` - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode` - `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` - `const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"` - `type BetaTextEditorCodeExecutionViewResultBlock struct{…}` - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockFileType` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` - `Type TextEditorCodeExecutionViewResult` - `const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"` - `type BetaTextEditorCodeExecutionCreateResultBlock struct{…}` - `IsFileUpdate bool` - `Type TextEditorCodeExecutionCreateResult` - `const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"` - `type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}` - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` - `Type TextEditorCodeExecutionStrReplaceResult` - `const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"` - `ToolUseID string` - `Type TextEditorCodeExecutionToolResult` - `const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"` - `type BetaToolSearchToolResultBlock struct{…}` - `Content BetaToolSearchToolResultBlockContentUnion` - `type BetaToolSearchToolResultError struct{…}` - `ErrorCode BetaToolSearchToolResultErrorErrorCode` - `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` - `const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"` - `type BetaToolSearchToolSearchResultBlock struct{…}` - `ToolReferences []BetaToolReferenceBlock` - `ToolName string` - `Type ToolReference` - `const ToolReferenceToolReference ToolReference = "tool_reference"` - `Type ToolSearchToolSearchResult` - `const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"` - `ToolUseID string` - `Type ToolSearchToolResult` - `const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"` - `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` - `const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"` - `type BetaMCPToolResultBlock struct{…}` - `Content BetaMCPToolResultBlockContentUnion` - `string` - `type BetaMCPToolResultBlockContentBetaMCPToolResultBlockContent []BetaTextBlock` - `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`. - `Text string` - `Type Text` - `IsError bool` - `ToolUseID string` - `Type MCPToolResult` - `const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"` - `type BetaContainerUploadBlock struct{…}` Response model for a file uploaded to the container. - `FileID string` - `Type ContainerUpload` - `const ContainerUploadContainerUpload ContainerUpload = "container_upload"` - `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 - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `Type Compaction` - `const CompactionCompaction Compaction = "compaction"` - `ContextManagement BetaContextManagementResponse` Context management response. Information about context management strategies applied during the request. - `AppliedEdits []BetaContextManagementResponseAppliedEditUnion` List of context management edits that were applied. - `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. - `const ClearToolUses20250919ClearToolUses20250919 ClearToolUses20250919 = "clear_tool_uses_20250919"` - `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. - `const ClearThinking20251015ClearThinking20251015 ClearThinking20251015 = "clear_thinking_20251015"` - `Diagnostics BetaDiagnostics` Response envelope for request-level diagnostics. Present (possibly null) whenever the caller supplied `diagnostics` on the request. - `CacheMissReason BetaDiagnosticsCacheMissReasonUnion` Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - `type BetaCacheMissModelChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type ModelChanged` - `const ModelChangedModelChanged ModelChanged = "model_changed"` - `type BetaCacheMissSystemChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type SystemChanged` - `const SystemChangedSystemChanged SystemChanged = "system_changed"` - `type BetaCacheMissToolsChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type ToolsChanged` - `const ToolsChangedToolsChanged ToolsChanged = "tools_changed"` - `type BetaCacheMissMessagesChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type MessagesChanged` - `const MessagesChangedMessagesChanged MessagesChanged = "messages_changed"` - `type BetaCacheMissPreviousMessageNotFound struct{…}` - `Type PreviousMessageNotFound` - `const PreviousMessageNotFoundPreviousMessageNotFound PreviousMessageNotFound = "previous_message_not_found"` - `type BetaCacheMissUnavailable struct{…}` - `Type Unavailable` - `const UnavailableUnavailable Unavailable = "unavailable"` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type Model string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `const ModelClaudeOpus4_1 Model = "claude-opus-4-1"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_0 Model = "claude-opus-4-0"` Powerful model for complex tasks - `const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"` Powerful model for complex tasks - `const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"` High-performance model with extended thinking - `const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"` High-performance model with extended thinking - `const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"` Fast and cost-effective model - `string` - `Role Assistant` Conversational role of the generated message. This will always be `"assistant"`. - `const AssistantAssistant Assistant = "assistant"` - `StopDetails BetaRefusalStopDetails` Structured information about a refusal. - `Category BetaRefusalStopDetailsCategory` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `const BetaRefusalStopDetailsCategoryCyber BetaRefusalStopDetailsCategory = "cyber"` - `const BetaRefusalStopDetailsCategoryBio BetaRefusalStopDetailsCategory = "bio"` - `Explanation string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `Type Refusal` - `const RefusalRefusal Refusal = "refusal"` - `StopReason BetaStopReason` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `const BetaStopReasonEndTurn BetaStopReason = "end_turn"` - `const BetaStopReasonMaxTokens BetaStopReason = "max_tokens"` - `const BetaStopReasonStopSequence BetaStopReason = "stop_sequence"` - `const BetaStopReasonToolUse BetaStopReason = "tool_use"` - `const BetaStopReasonPauseTurn BetaStopReason = "pause_turn"` - `const BetaStopReasonCompaction BetaStopReason = "compaction"` - `const BetaStopReasonRefusal BetaStopReason = "refusal"` - `const BetaStopReasonModelContextWindowExceeded BetaStopReason = "model_context_window_exceeded"` - `StopSequence string` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `Type Message` Object type. For Messages, this is always `"message"`. - `const MessageMessage Message = "message"` - `Usage BetaUsage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `CacheCreation 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. - `InferenceGeo string` The geographic region where inference was performed for this request. - `InputTokens int64` The number of input tokens which were used. - `Iterations BetaIterationsUsage` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the true context window size from the last iteration - Understand token accumulation across server-side tool use loops - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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 Message` Usage for a sampling iteration - `const MessageMessage Message = "message"` - `type BetaCompactionIterationUsage struct{…}` Token usage for a compaction iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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 - `const CompactionCompaction Compaction = "compaction"` - `type BetaAdvisorMessageIterationUsage struct{…}` Token usage for an advisor sub-inference iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. - `Type AdvisorMessage` Usage for an advisor sub-inference iteration - `const AdvisorMessageAdvisorMessage AdvisorMessage = "advisor_message"` - `OutputTokens int64` The number of output tokens which were used. - `OutputTokensDetails BetaOutputTokensDetails` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `ThinkingTokens int64` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. - `ServerToolUse BetaServerToolUsage` The number of server tool requests. - `WebFetchRequests int64` The number of web fetch tool requests. - `WebSearchRequests int64` The number of web search tool requests. - `ServiceTier BetaUsageServiceTier` If the request used the priority, standard, or batch tier. - `const BetaUsageServiceTierStandard BetaUsageServiceTier = "standard"` - `const BetaUsageServiceTierPriority BetaUsageServiceTier = "priority"` - `const BetaUsageServiceTierBatch BetaUsageServiceTier = "batch"` - `Speed BetaUsageSpeed` The inference speed mode used for this request. - `const BetaUsageSpeedStandard BetaUsageSpeed = "standard"` - `const BetaUsageSpeedFast BetaUsageSpeed = "fast"` - `Type Succeeded` - `const SucceededSucceeded Succeeded = "succeeded"` - `type BetaMessageBatchErroredResult struct{…}` - `Error BetaErrorResponse` - `Error BetaErrorUnion` - `type BetaInvalidRequestError struct{…}` - `Message string` - `Type InvalidRequestError` - `const InvalidRequestErrorInvalidRequestError InvalidRequestError = "invalid_request_error"` - `type BetaAuthenticationError struct{…}` - `Message string` - `Type AuthenticationError` - `const AuthenticationErrorAuthenticationError AuthenticationError = "authentication_error"` - `type BetaBillingError struct{…}` - `Message string` - `Type BillingError` - `const BillingErrorBillingError BillingError = "billing_error"` - `type BetaPermissionError struct{…}` - `Message string` - `Type PermissionError` - `const PermissionErrorPermissionError PermissionError = "permission_error"` - `type BetaNotFoundError struct{…}` - `Message string` - `Type NotFoundError` - `const NotFoundErrorNotFoundError NotFoundError = "not_found_error"` - `type BetaRateLimitError struct{…}` - `Message string` - `Type RateLimitError` - `const RateLimitErrorRateLimitError RateLimitError = "rate_limit_error"` - `type BetaGatewayTimeoutError struct{…}` - `Message string` - `Type TimeoutError` - `const TimeoutErrorTimeoutError TimeoutError = "timeout_error"` - `type BetaAPIError struct{…}` - `Message string` - `Type APIError` - `const APIErrorAPIError APIError = "api_error"` - `type BetaOverloadedError struct{…}` - `Message string` - `Type OverloadedError` - `const OverloadedErrorOverloadedError OverloadedError = "overloaded_error"` - `RequestID string` - `Type Error` - `const ErrorError Error = "error"` - `Type Errored` - `const ErroredErrored Errored = "errored"` - `type BetaMessageBatchCanceledResult struct{…}` - `Type Canceled` - `const CanceledCanceled Canceled = "canceled"` - `type BetaMessageBatchExpiredResult struct{…}` - `Type Expired` - `const ExpiredExpired Expired = "expired"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) stream := client.Beta.Messages.Batches.ResultsStreaming( context.TODO(), "message_batch_id", anthropic.BetaMessageBatchResultsParams{ }, ) for stream.Next() { fmt.Printf("%+v\n", stream.Current()) } err := stream.Err() if err != nil { panic(err.Error()) } } ``` ## Domain Types ### Beta Deleted Message Batch - `type BetaDeletedMessageBatch struct{…}` - `ID string` ID of the Message Batch. - `Type MessageBatchDeleted` Deleted object type. For Message Batches, this is always `"message_batch_deleted"`. - `const MessageBatchDeletedMessageBatchDeleted MessageBatchDeleted = "message_batch_deleted"` ### Beta Message Batch - `type BetaMessageBatch struct{…}` - `ID string` Unique object identifier. The format and length of IDs may change over time. - `ArchivedAt Time` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. - `CancelInitiatedAt Time` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. - `CreatedAt Time` RFC 3339 datetime string representing the time at which the Message Batch was created. - `EndedAt Time` RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends. Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired. - `ExpiresAt Time` RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. - `ProcessingStatus BetaMessageBatchProcessingStatus` Processing status of the Message Batch. - `const BetaMessageBatchProcessingStatusInProgress BetaMessageBatchProcessingStatus = "in_progress"` - `const BetaMessageBatchProcessingStatusCanceling BetaMessageBatchProcessingStatus = "canceling"` - `const BetaMessageBatchProcessingStatusEnded BetaMessageBatchProcessingStatus = "ended"` - `RequestCounts BetaMessageBatchRequestCounts` Tallies requests within the Message Batch, categorized by their status. Requests start as `processing` and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch. - `Canceled int64` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. - `Errored int64` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. - `Expired int64` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. - `Processing int64` Number of requests in the Message Batch that are processing. - `Succeeded int64` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. - `ResultsURL string` URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. - `Type MessageBatch` Object type. For Message Batches, this is always `"message_batch"`. - `const MessageBatchMessageBatch MessageBatch = "message_batch"` ### Beta Message Batch Canceled Result - `type BetaMessageBatchCanceledResult struct{…}` - `Type Canceled` - `const CanceledCanceled Canceled = "canceled"` ### Beta Message Batch Errored Result - `type BetaMessageBatchErroredResult struct{…}` - `Error BetaErrorResponse` - `Error BetaErrorUnion` - `type BetaInvalidRequestError struct{…}` - `Message string` - `Type InvalidRequestError` - `const InvalidRequestErrorInvalidRequestError InvalidRequestError = "invalid_request_error"` - `type BetaAuthenticationError struct{…}` - `Message string` - `Type AuthenticationError` - `const AuthenticationErrorAuthenticationError AuthenticationError = "authentication_error"` - `type BetaBillingError struct{…}` - `Message string` - `Type BillingError` - `const BillingErrorBillingError BillingError = "billing_error"` - `type BetaPermissionError struct{…}` - `Message string` - `Type PermissionError` - `const PermissionErrorPermissionError PermissionError = "permission_error"` - `type BetaNotFoundError struct{…}` - `Message string` - `Type NotFoundError` - `const NotFoundErrorNotFoundError NotFoundError = "not_found_error"` - `type BetaRateLimitError struct{…}` - `Message string` - `Type RateLimitError` - `const RateLimitErrorRateLimitError RateLimitError = "rate_limit_error"` - `type BetaGatewayTimeoutError struct{…}` - `Message string` - `Type TimeoutError` - `const TimeoutErrorTimeoutError TimeoutError = "timeout_error"` - `type BetaAPIError struct{…}` - `Message string` - `Type APIError` - `const APIErrorAPIError APIError = "api_error"` - `type BetaOverloadedError struct{…}` - `Message string` - `Type OverloadedError` - `const OverloadedErrorOverloadedError OverloadedError = "overloaded_error"` - `RequestID string` - `Type Error` - `const ErrorError Error = "error"` - `Type Errored` - `const ErroredErrored Errored = "errored"` ### Beta Message Batch Expired Result - `type BetaMessageBatchExpiredResult struct{…}` - `Type Expired` - `const ExpiredExpired Expired = "expired"` ### Beta Message Batch Individual Response - `type BetaMessageBatchIndividualResponse struct{…}` This is a single line in the response `.jsonl` file and does not represent the response as a whole. - `CustomID string` Developer-provided ID created for each request in a Message Batch. Useful for matching results to requests, as results may be given out of request order. Must be unique for each request within the Message Batch. - `Result BetaMessageBatchResultUnion` Processing result for this request. Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration. - `type BetaMessageBatchSucceededResult struct{…}` - `Message BetaMessage` - `ID string` Unique object identifier. The format and length of IDs may change over time. - `Container BetaContainer` Information about the container used in the request (for the code execution tool) - `ID string` Identifier for the container used in this request - `ExpiresAt Time` The time at which the container will expire. - `Skills []BetaSkill` Skills loaded in the container - `SkillID string` Skill ID - `Type BetaSkillType` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `const BetaSkillTypeAnthropic BetaSkillType = "anthropic"` - `const BetaSkillTypeCustom BetaSkillType = "custom"` - `Version string` Skill version or 'latest' for most recent version - `Content []BetaContentBlockUnion` Content generated by the model. This is an array of content blocks, each of which has a `type` that determines its shape. Example: ```json [{"type": "text", "text": "Hi, I'm Claude."}] ``` If the request input `messages` ended with an `assistant` turn, then the response `content` will continue directly from that last turn. You can use this to constrain the model's output. For example, if the input `messages` were: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("} ] ``` Then the response `content` might be: ```json [{"type": "text", "text": "B)"}] ``` - `type BetaTextBlock struct{…}` - `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`. - `type BetaCitationCharLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationsWebSearchResultLocation struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `Text string` - `Type Text` - `const TextText Text = "text"` - `type BetaThinkingBlock struct{…}` - `Signature string` - `Thinking string` - `Type Thinking` - `const ThinkingThinking Thinking = "thinking"` - `type BetaRedactedThinkingBlock struct{…}` - `Data string` - `Type RedactedThinking` - `const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"` - `type BetaToolUseBlock struct{…}` - `ID string` - `Input map[string, any]` - `Name string` - `Type ToolUse` - `const ToolUseToolUse ToolUse = "tool_use"` - `Caller BetaToolUseBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `Type Direct` - `const DirectDirect Direct = "direct"` - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `ToolID string` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `type BetaServerToolCaller20260120 struct{…}` - `ToolID string` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` - `type BetaServerToolUseBlock struct{…}` - `ID string` - `Input map[string, any]` - `Name BetaServerToolUseBlockName` - `const BetaServerToolUseBlockNameAdvisor BetaServerToolUseBlockName = "advisor"` - `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` - `const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"` - `Caller BetaServerToolUseBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebSearchToolResultBlock struct{…}` - `Content BetaWebSearchToolResultBlockContentUnion` - `type BetaWebSearchToolResultError struct{…}` - `ErrorCode BetaWebSearchToolResultErrorCode` - `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` - `const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"` - `type BetaWebSearchToolResultBlockContentArray []BetaWebSearchResultBlock` - `EncryptedContent string` - `PageAge string` - `Title string` - `Type WebSearchResult` - `const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"` - `URL string` - `ToolUseID string` - `Type WebSearchToolResult` - `const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"` - `Caller BetaWebSearchToolResultBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebFetchToolResultBlock struct{…}` - `Content BetaWebFetchToolResultBlockContentUnion` - `type BetaWebFetchToolResultErrorBlock struct{…}` - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `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` - `const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"` - `type BetaWebFetchBlock struct{…}` - `Content BetaDocumentBlock` - `Citations BetaCitationConfig` Citation configuration for the document - `Enabled bool` - `Source BetaDocumentBlockSourceUnion` - `type BetaBase64PDFSource struct{…}` - `Data string` - `MediaType ApplicationPDF` - `const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaPlainTextSource struct{…}` - `Data string` - `MediaType TextPlain` - `const TextPlainTextPlain TextPlain = "text/plain"` - `Type Text` - `const TextText Text = "text"` - `Title string` The title of the document - `Type Document` - `const DocumentDocument Document = "document"` - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved - `Type WebFetchResult` - `const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"` - `URL string` Fetched content URL - `ToolUseID string` - `Type WebFetchToolResult` - `const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"` - `Caller BetaWebFetchToolResultBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaAdvisorToolResultBlock struct{…}` - `Content BetaAdvisorToolResultBlockContentUnion` - `type BetaAdvisorToolResultError struct{…}` - `ErrorCode BetaAdvisorToolResultErrorErrorCode` - `const BetaAdvisorToolResultErrorErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodePromptTooLong BetaAdvisorToolResultErrorErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorErrorCodeTooManyRequests BetaAdvisorToolResultErrorErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorErrorCodeOverloaded BetaAdvisorToolResultErrorErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorErrorCodeUnavailable BetaAdvisorToolResultErrorErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorErrorCode = "execution_time_exceeded"` - `Type AdvisorToolResultError` - `const AdvisorToolResultErrorAdvisorToolResultError AdvisorToolResultError = "advisor_tool_result_error"` - `type BetaAdvisorResultBlock struct{…}` - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `Text string` - `Type AdvisorResult` - `const AdvisorResultAdvisorResult AdvisorResult = "advisor_result"` - `type BetaAdvisorRedactedResultBlock struct{…}` - `EncryptedContent string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `Type AdvisorRedactedResult` - `const AdvisorRedactedResultAdvisorRedactedResult AdvisorRedactedResult = "advisor_redacted_result"` - `ToolUseID string` - `Type AdvisorToolResult` - `const AdvisorToolResultAdvisorToolResult AdvisorToolResult = "advisor_tool_result"` - `type BetaCodeExecutionToolResultBlock struct{…}` - `Content BetaCodeExecutionToolResultBlockContentUnion` Code execution result with encrypted stdout for PFC + web_search results. - `type BetaCodeExecutionToolResultError struct{…}` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `Type CodeExecutionToolResultError` - `const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"` - `type BetaCodeExecutionResultBlock struct{…}` - `Content []BetaCodeExecutionOutputBlock` - `FileID string` - `Type CodeExecutionOutput` - `const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type CodeExecutionResult` - `const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"` - `type BetaEncryptedCodeExecutionResultBlock struct{…}` Code execution result with encrypted stdout for PFC + web_search results. - `Content []BetaCodeExecutionOutputBlock` - `FileID string` - `Type CodeExecutionOutput` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `Type EncryptedCodeExecutionResult` - `const EncryptedCodeExecutionResultEncryptedCodeExecutionResult EncryptedCodeExecutionResult = "encrypted_code_execution_result"` - `ToolUseID string` - `Type CodeExecutionToolResult` - `const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"` - `type BetaBashCodeExecutionToolResultBlock struct{…}` - `Content BetaBashCodeExecutionToolResultBlockContentUnion` - `type BetaBashCodeExecutionToolResultError struct{…}` - `ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode` - `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` - `const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"` - `type BetaBashCodeExecutionResultBlock struct{…}` - `Content []BetaBashCodeExecutionOutputBlock` - `FileID string` - `Type BashCodeExecutionOutput` - `const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type BashCodeExecutionResult` - `const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"` - `ToolUseID string` - `Type BashCodeExecutionToolResult` - `const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"` - `type BetaTextEditorCodeExecutionToolResultBlock struct{…}` - `Content BetaTextEditorCodeExecutionToolResultBlockContentUnion` - `type BetaTextEditorCodeExecutionToolResultError struct{…}` - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode` - `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` - `const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"` - `type BetaTextEditorCodeExecutionViewResultBlock struct{…}` - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockFileType` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` - `Type TextEditorCodeExecutionViewResult` - `const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"` - `type BetaTextEditorCodeExecutionCreateResultBlock struct{…}` - `IsFileUpdate bool` - `Type TextEditorCodeExecutionCreateResult` - `const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"` - `type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}` - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` - `Type TextEditorCodeExecutionStrReplaceResult` - `const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"` - `ToolUseID string` - `Type TextEditorCodeExecutionToolResult` - `const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"` - `type BetaToolSearchToolResultBlock struct{…}` - `Content BetaToolSearchToolResultBlockContentUnion` - `type BetaToolSearchToolResultError struct{…}` - `ErrorCode BetaToolSearchToolResultErrorErrorCode` - `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` - `const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"` - `type BetaToolSearchToolSearchResultBlock struct{…}` - `ToolReferences []BetaToolReferenceBlock` - `ToolName string` - `Type ToolReference` - `const ToolReferenceToolReference ToolReference = "tool_reference"` - `Type ToolSearchToolSearchResult` - `const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"` - `ToolUseID string` - `Type ToolSearchToolResult` - `const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"` - `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` - `const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"` - `type BetaMCPToolResultBlock struct{…}` - `Content BetaMCPToolResultBlockContentUnion` - `string` - `type BetaMCPToolResultBlockContentBetaMCPToolResultBlockContent []BetaTextBlock` - `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`. - `Text string` - `Type Text` - `IsError bool` - `ToolUseID string` - `Type MCPToolResult` - `const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"` - `type BetaContainerUploadBlock struct{…}` Response model for a file uploaded to the container. - `FileID string` - `Type ContainerUpload` - `const ContainerUploadContainerUpload ContainerUpload = "container_upload"` - `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 - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `Type Compaction` - `const CompactionCompaction Compaction = "compaction"` - `ContextManagement BetaContextManagementResponse` Context management response. Information about context management strategies applied during the request. - `AppliedEdits []BetaContextManagementResponseAppliedEditUnion` List of context management edits that were applied. - `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. - `const ClearToolUses20250919ClearToolUses20250919 ClearToolUses20250919 = "clear_tool_uses_20250919"` - `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. - `const ClearThinking20251015ClearThinking20251015 ClearThinking20251015 = "clear_thinking_20251015"` - `Diagnostics BetaDiagnostics` Response envelope for request-level diagnostics. Present (possibly null) whenever the caller supplied `diagnostics` on the request. - `CacheMissReason BetaDiagnosticsCacheMissReasonUnion` Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - `type BetaCacheMissModelChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type ModelChanged` - `const ModelChangedModelChanged ModelChanged = "model_changed"` - `type BetaCacheMissSystemChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type SystemChanged` - `const SystemChangedSystemChanged SystemChanged = "system_changed"` - `type BetaCacheMissToolsChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type ToolsChanged` - `const ToolsChangedToolsChanged ToolsChanged = "tools_changed"` - `type BetaCacheMissMessagesChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type MessagesChanged` - `const MessagesChangedMessagesChanged MessagesChanged = "messages_changed"` - `type BetaCacheMissPreviousMessageNotFound struct{…}` - `Type PreviousMessageNotFound` - `const PreviousMessageNotFoundPreviousMessageNotFound PreviousMessageNotFound = "previous_message_not_found"` - `type BetaCacheMissUnavailable struct{…}` - `Type Unavailable` - `const UnavailableUnavailable Unavailable = "unavailable"` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type Model string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `const ModelClaudeOpus4_1 Model = "claude-opus-4-1"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_0 Model = "claude-opus-4-0"` Powerful model for complex tasks - `const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"` Powerful model for complex tasks - `const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"` High-performance model with extended thinking - `const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"` High-performance model with extended thinking - `const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"` Fast and cost-effective model - `string` - `Role Assistant` Conversational role of the generated message. This will always be `"assistant"`. - `const AssistantAssistant Assistant = "assistant"` - `StopDetails BetaRefusalStopDetails` Structured information about a refusal. - `Category BetaRefusalStopDetailsCategory` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `const BetaRefusalStopDetailsCategoryCyber BetaRefusalStopDetailsCategory = "cyber"` - `const BetaRefusalStopDetailsCategoryBio BetaRefusalStopDetailsCategory = "bio"` - `Explanation string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `Type Refusal` - `const RefusalRefusal Refusal = "refusal"` - `StopReason BetaStopReason` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `const BetaStopReasonEndTurn BetaStopReason = "end_turn"` - `const BetaStopReasonMaxTokens BetaStopReason = "max_tokens"` - `const BetaStopReasonStopSequence BetaStopReason = "stop_sequence"` - `const BetaStopReasonToolUse BetaStopReason = "tool_use"` - `const BetaStopReasonPauseTurn BetaStopReason = "pause_turn"` - `const BetaStopReasonCompaction BetaStopReason = "compaction"` - `const BetaStopReasonRefusal BetaStopReason = "refusal"` - `const BetaStopReasonModelContextWindowExceeded BetaStopReason = "model_context_window_exceeded"` - `StopSequence string` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `Type Message` Object type. For Messages, this is always `"message"`. - `const MessageMessage Message = "message"` - `Usage BetaUsage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `CacheCreation 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. - `InferenceGeo string` The geographic region where inference was performed for this request. - `InputTokens int64` The number of input tokens which were used. - `Iterations BetaIterationsUsage` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the true context window size from the last iteration - Understand token accumulation across server-side tool use loops - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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 Message` Usage for a sampling iteration - `const MessageMessage Message = "message"` - `type BetaCompactionIterationUsage struct{…}` Token usage for a compaction iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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 - `const CompactionCompaction Compaction = "compaction"` - `type BetaAdvisorMessageIterationUsage struct{…}` Token usage for an advisor sub-inference iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. - `Type AdvisorMessage` Usage for an advisor sub-inference iteration - `const AdvisorMessageAdvisorMessage AdvisorMessage = "advisor_message"` - `OutputTokens int64` The number of output tokens which were used. - `OutputTokensDetails BetaOutputTokensDetails` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `ThinkingTokens int64` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. - `ServerToolUse BetaServerToolUsage` The number of server tool requests. - `WebFetchRequests int64` The number of web fetch tool requests. - `WebSearchRequests int64` The number of web search tool requests. - `ServiceTier BetaUsageServiceTier` If the request used the priority, standard, or batch tier. - `const BetaUsageServiceTierStandard BetaUsageServiceTier = "standard"` - `const BetaUsageServiceTierPriority BetaUsageServiceTier = "priority"` - `const BetaUsageServiceTierBatch BetaUsageServiceTier = "batch"` - `Speed BetaUsageSpeed` The inference speed mode used for this request. - `const BetaUsageSpeedStandard BetaUsageSpeed = "standard"` - `const BetaUsageSpeedFast BetaUsageSpeed = "fast"` - `Type Succeeded` - `const SucceededSucceeded Succeeded = "succeeded"` - `type BetaMessageBatchErroredResult struct{…}` - `Error BetaErrorResponse` - `Error BetaErrorUnion` - `type BetaInvalidRequestError struct{…}` - `Message string` - `Type InvalidRequestError` - `const InvalidRequestErrorInvalidRequestError InvalidRequestError = "invalid_request_error"` - `type BetaAuthenticationError struct{…}` - `Message string` - `Type AuthenticationError` - `const AuthenticationErrorAuthenticationError AuthenticationError = "authentication_error"` - `type BetaBillingError struct{…}` - `Message string` - `Type BillingError` - `const BillingErrorBillingError BillingError = "billing_error"` - `type BetaPermissionError struct{…}` - `Message string` - `Type PermissionError` - `const PermissionErrorPermissionError PermissionError = "permission_error"` - `type BetaNotFoundError struct{…}` - `Message string` - `Type NotFoundError` - `const NotFoundErrorNotFoundError NotFoundError = "not_found_error"` - `type BetaRateLimitError struct{…}` - `Message string` - `Type RateLimitError` - `const RateLimitErrorRateLimitError RateLimitError = "rate_limit_error"` - `type BetaGatewayTimeoutError struct{…}` - `Message string` - `Type TimeoutError` - `const TimeoutErrorTimeoutError TimeoutError = "timeout_error"` - `type BetaAPIError struct{…}` - `Message string` - `Type APIError` - `const APIErrorAPIError APIError = "api_error"` - `type BetaOverloadedError struct{…}` - `Message string` - `Type OverloadedError` - `const OverloadedErrorOverloadedError OverloadedError = "overloaded_error"` - `RequestID string` - `Type Error` - `const ErrorError Error = "error"` - `Type Errored` - `const ErroredErrored Errored = "errored"` - `type BetaMessageBatchCanceledResult struct{…}` - `Type Canceled` - `const CanceledCanceled Canceled = "canceled"` - `type BetaMessageBatchExpiredResult struct{…}` - `Type Expired` - `const ExpiredExpired Expired = "expired"` ### Beta Message Batch Request Counts - `type BetaMessageBatchRequestCounts struct{…}` - `Canceled int64` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. - `Errored int64` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. - `Expired int64` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. - `Processing int64` Number of requests in the Message Batch that are processing. - `Succeeded int64` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. ### Beta Message Batch Result - `type BetaMessageBatchResultUnion interface{…}` Processing result for this request. Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration. - `type BetaMessageBatchSucceededResult struct{…}` - `Message BetaMessage` - `ID string` Unique object identifier. The format and length of IDs may change over time. - `Container BetaContainer` Information about the container used in the request (for the code execution tool) - `ID string` Identifier for the container used in this request - `ExpiresAt Time` The time at which the container will expire. - `Skills []BetaSkill` Skills loaded in the container - `SkillID string` Skill ID - `Type BetaSkillType` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `const BetaSkillTypeAnthropic BetaSkillType = "anthropic"` - `const BetaSkillTypeCustom BetaSkillType = "custom"` - `Version string` Skill version or 'latest' for most recent version - `Content []BetaContentBlockUnion` Content generated by the model. This is an array of content blocks, each of which has a `type` that determines its shape. Example: ```json [{"type": "text", "text": "Hi, I'm Claude."}] ``` If the request input `messages` ended with an `assistant` turn, then the response `content` will continue directly from that last turn. You can use this to constrain the model's output. For example, if the input `messages` were: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("} ] ``` Then the response `content` might be: ```json [{"type": "text", "text": "B)"}] ``` - `type BetaTextBlock struct{…}` - `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`. - `type BetaCitationCharLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationsWebSearchResultLocation struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `Text string` - `Type Text` - `const TextText Text = "text"` - `type BetaThinkingBlock struct{…}` - `Signature string` - `Thinking string` - `Type Thinking` - `const ThinkingThinking Thinking = "thinking"` - `type BetaRedactedThinkingBlock struct{…}` - `Data string` - `Type RedactedThinking` - `const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"` - `type BetaToolUseBlock struct{…}` - `ID string` - `Input map[string, any]` - `Name string` - `Type ToolUse` - `const ToolUseToolUse ToolUse = "tool_use"` - `Caller BetaToolUseBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `Type Direct` - `const DirectDirect Direct = "direct"` - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `ToolID string` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `type BetaServerToolCaller20260120 struct{…}` - `ToolID string` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` - `type BetaServerToolUseBlock struct{…}` - `ID string` - `Input map[string, any]` - `Name BetaServerToolUseBlockName` - `const BetaServerToolUseBlockNameAdvisor BetaServerToolUseBlockName = "advisor"` - `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` - `const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"` - `Caller BetaServerToolUseBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebSearchToolResultBlock struct{…}` - `Content BetaWebSearchToolResultBlockContentUnion` - `type BetaWebSearchToolResultError struct{…}` - `ErrorCode BetaWebSearchToolResultErrorCode` - `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` - `const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"` - `type BetaWebSearchToolResultBlockContentArray []BetaWebSearchResultBlock` - `EncryptedContent string` - `PageAge string` - `Title string` - `Type WebSearchResult` - `const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"` - `URL string` - `ToolUseID string` - `Type WebSearchToolResult` - `const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"` - `Caller BetaWebSearchToolResultBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebFetchToolResultBlock struct{…}` - `Content BetaWebFetchToolResultBlockContentUnion` - `type BetaWebFetchToolResultErrorBlock struct{…}` - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `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` - `const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"` - `type BetaWebFetchBlock struct{…}` - `Content BetaDocumentBlock` - `Citations BetaCitationConfig` Citation configuration for the document - `Enabled bool` - `Source BetaDocumentBlockSourceUnion` - `type BetaBase64PDFSource struct{…}` - `Data string` - `MediaType ApplicationPDF` - `const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaPlainTextSource struct{…}` - `Data string` - `MediaType TextPlain` - `const TextPlainTextPlain TextPlain = "text/plain"` - `Type Text` - `const TextText Text = "text"` - `Title string` The title of the document - `Type Document` - `const DocumentDocument Document = "document"` - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved - `Type WebFetchResult` - `const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"` - `URL string` Fetched content URL - `ToolUseID string` - `Type WebFetchToolResult` - `const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"` - `Caller BetaWebFetchToolResultBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaAdvisorToolResultBlock struct{…}` - `Content BetaAdvisorToolResultBlockContentUnion` - `type BetaAdvisorToolResultError struct{…}` - `ErrorCode BetaAdvisorToolResultErrorErrorCode` - `const BetaAdvisorToolResultErrorErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodePromptTooLong BetaAdvisorToolResultErrorErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorErrorCodeTooManyRequests BetaAdvisorToolResultErrorErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorErrorCodeOverloaded BetaAdvisorToolResultErrorErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorErrorCodeUnavailable BetaAdvisorToolResultErrorErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorErrorCode = "execution_time_exceeded"` - `Type AdvisorToolResultError` - `const AdvisorToolResultErrorAdvisorToolResultError AdvisorToolResultError = "advisor_tool_result_error"` - `type BetaAdvisorResultBlock struct{…}` - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `Text string` - `Type AdvisorResult` - `const AdvisorResultAdvisorResult AdvisorResult = "advisor_result"` - `type BetaAdvisorRedactedResultBlock struct{…}` - `EncryptedContent string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `Type AdvisorRedactedResult` - `const AdvisorRedactedResultAdvisorRedactedResult AdvisorRedactedResult = "advisor_redacted_result"` - `ToolUseID string` - `Type AdvisorToolResult` - `const AdvisorToolResultAdvisorToolResult AdvisorToolResult = "advisor_tool_result"` - `type BetaCodeExecutionToolResultBlock struct{…}` - `Content BetaCodeExecutionToolResultBlockContentUnion` Code execution result with encrypted stdout for PFC + web_search results. - `type BetaCodeExecutionToolResultError struct{…}` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `Type CodeExecutionToolResultError` - `const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"` - `type BetaCodeExecutionResultBlock struct{…}` - `Content []BetaCodeExecutionOutputBlock` - `FileID string` - `Type CodeExecutionOutput` - `const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type CodeExecutionResult` - `const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"` - `type BetaEncryptedCodeExecutionResultBlock struct{…}` Code execution result with encrypted stdout for PFC + web_search results. - `Content []BetaCodeExecutionOutputBlock` - `FileID string` - `Type CodeExecutionOutput` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `Type EncryptedCodeExecutionResult` - `const EncryptedCodeExecutionResultEncryptedCodeExecutionResult EncryptedCodeExecutionResult = "encrypted_code_execution_result"` - `ToolUseID string` - `Type CodeExecutionToolResult` - `const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"` - `type BetaBashCodeExecutionToolResultBlock struct{…}` - `Content BetaBashCodeExecutionToolResultBlockContentUnion` - `type BetaBashCodeExecutionToolResultError struct{…}` - `ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode` - `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` - `const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"` - `type BetaBashCodeExecutionResultBlock struct{…}` - `Content []BetaBashCodeExecutionOutputBlock` - `FileID string` - `Type BashCodeExecutionOutput` - `const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type BashCodeExecutionResult` - `const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"` - `ToolUseID string` - `Type BashCodeExecutionToolResult` - `const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"` - `type BetaTextEditorCodeExecutionToolResultBlock struct{…}` - `Content BetaTextEditorCodeExecutionToolResultBlockContentUnion` - `type BetaTextEditorCodeExecutionToolResultError struct{…}` - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode` - `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` - `const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"` - `type BetaTextEditorCodeExecutionViewResultBlock struct{…}` - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockFileType` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` - `Type TextEditorCodeExecutionViewResult` - `const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"` - `type BetaTextEditorCodeExecutionCreateResultBlock struct{…}` - `IsFileUpdate bool` - `Type TextEditorCodeExecutionCreateResult` - `const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"` - `type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}` - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` - `Type TextEditorCodeExecutionStrReplaceResult` - `const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"` - `ToolUseID string` - `Type TextEditorCodeExecutionToolResult` - `const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"` - `type BetaToolSearchToolResultBlock struct{…}` - `Content BetaToolSearchToolResultBlockContentUnion` - `type BetaToolSearchToolResultError struct{…}` - `ErrorCode BetaToolSearchToolResultErrorErrorCode` - `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` - `const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"` - `type BetaToolSearchToolSearchResultBlock struct{…}` - `ToolReferences []BetaToolReferenceBlock` - `ToolName string` - `Type ToolReference` - `const ToolReferenceToolReference ToolReference = "tool_reference"` - `Type ToolSearchToolSearchResult` - `const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"` - `ToolUseID string` - `Type ToolSearchToolResult` - `const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"` - `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` - `const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"` - `type BetaMCPToolResultBlock struct{…}` - `Content BetaMCPToolResultBlockContentUnion` - `string` - `type BetaMCPToolResultBlockContentBetaMCPToolResultBlockContent []BetaTextBlock` - `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`. - `Text string` - `Type Text` - `IsError bool` - `ToolUseID string` - `Type MCPToolResult` - `const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"` - `type BetaContainerUploadBlock struct{…}` Response model for a file uploaded to the container. - `FileID string` - `Type ContainerUpload` - `const ContainerUploadContainerUpload ContainerUpload = "container_upload"` - `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 - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `Type Compaction` - `const CompactionCompaction Compaction = "compaction"` - `ContextManagement BetaContextManagementResponse` Context management response. Information about context management strategies applied during the request. - `AppliedEdits []BetaContextManagementResponseAppliedEditUnion` List of context management edits that were applied. - `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. - `const ClearToolUses20250919ClearToolUses20250919 ClearToolUses20250919 = "clear_tool_uses_20250919"` - `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. - `const ClearThinking20251015ClearThinking20251015 ClearThinking20251015 = "clear_thinking_20251015"` - `Diagnostics BetaDiagnostics` Response envelope for request-level diagnostics. Present (possibly null) whenever the caller supplied `diagnostics` on the request. - `CacheMissReason BetaDiagnosticsCacheMissReasonUnion` Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - `type BetaCacheMissModelChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type ModelChanged` - `const ModelChangedModelChanged ModelChanged = "model_changed"` - `type BetaCacheMissSystemChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type SystemChanged` - `const SystemChangedSystemChanged SystemChanged = "system_changed"` - `type BetaCacheMissToolsChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type ToolsChanged` - `const ToolsChangedToolsChanged ToolsChanged = "tools_changed"` - `type BetaCacheMissMessagesChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type MessagesChanged` - `const MessagesChangedMessagesChanged MessagesChanged = "messages_changed"` - `type BetaCacheMissPreviousMessageNotFound struct{…}` - `Type PreviousMessageNotFound` - `const PreviousMessageNotFoundPreviousMessageNotFound PreviousMessageNotFound = "previous_message_not_found"` - `type BetaCacheMissUnavailable struct{…}` - `Type Unavailable` - `const UnavailableUnavailable Unavailable = "unavailable"` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type Model string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `const ModelClaudeOpus4_1 Model = "claude-opus-4-1"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_0 Model = "claude-opus-4-0"` Powerful model for complex tasks - `const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"` Powerful model for complex tasks - `const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"` High-performance model with extended thinking - `const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"` High-performance model with extended thinking - `const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"` Fast and cost-effective model - `string` - `Role Assistant` Conversational role of the generated message. This will always be `"assistant"`. - `const AssistantAssistant Assistant = "assistant"` - `StopDetails BetaRefusalStopDetails` Structured information about a refusal. - `Category BetaRefusalStopDetailsCategory` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `const BetaRefusalStopDetailsCategoryCyber BetaRefusalStopDetailsCategory = "cyber"` - `const BetaRefusalStopDetailsCategoryBio BetaRefusalStopDetailsCategory = "bio"` - `Explanation string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `Type Refusal` - `const RefusalRefusal Refusal = "refusal"` - `StopReason BetaStopReason` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `const BetaStopReasonEndTurn BetaStopReason = "end_turn"` - `const BetaStopReasonMaxTokens BetaStopReason = "max_tokens"` - `const BetaStopReasonStopSequence BetaStopReason = "stop_sequence"` - `const BetaStopReasonToolUse BetaStopReason = "tool_use"` - `const BetaStopReasonPauseTurn BetaStopReason = "pause_turn"` - `const BetaStopReasonCompaction BetaStopReason = "compaction"` - `const BetaStopReasonRefusal BetaStopReason = "refusal"` - `const BetaStopReasonModelContextWindowExceeded BetaStopReason = "model_context_window_exceeded"` - `StopSequence string` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `Type Message` Object type. For Messages, this is always `"message"`. - `const MessageMessage Message = "message"` - `Usage BetaUsage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `CacheCreation 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. - `InferenceGeo string` The geographic region where inference was performed for this request. - `InputTokens int64` The number of input tokens which were used. - `Iterations BetaIterationsUsage` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the true context window size from the last iteration - Understand token accumulation across server-side tool use loops - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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 Message` Usage for a sampling iteration - `const MessageMessage Message = "message"` - `type BetaCompactionIterationUsage struct{…}` Token usage for a compaction iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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 - `const CompactionCompaction Compaction = "compaction"` - `type BetaAdvisorMessageIterationUsage struct{…}` Token usage for an advisor sub-inference iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. - `Type AdvisorMessage` Usage for an advisor sub-inference iteration - `const AdvisorMessageAdvisorMessage AdvisorMessage = "advisor_message"` - `OutputTokens int64` The number of output tokens which were used. - `OutputTokensDetails BetaOutputTokensDetails` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `ThinkingTokens int64` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. - `ServerToolUse BetaServerToolUsage` The number of server tool requests. - `WebFetchRequests int64` The number of web fetch tool requests. - `WebSearchRequests int64` The number of web search tool requests. - `ServiceTier BetaUsageServiceTier` If the request used the priority, standard, or batch tier. - `const BetaUsageServiceTierStandard BetaUsageServiceTier = "standard"` - `const BetaUsageServiceTierPriority BetaUsageServiceTier = "priority"` - `const BetaUsageServiceTierBatch BetaUsageServiceTier = "batch"` - `Speed BetaUsageSpeed` The inference speed mode used for this request. - `const BetaUsageSpeedStandard BetaUsageSpeed = "standard"` - `const BetaUsageSpeedFast BetaUsageSpeed = "fast"` - `Type Succeeded` - `const SucceededSucceeded Succeeded = "succeeded"` - `type BetaMessageBatchErroredResult struct{…}` - `Error BetaErrorResponse` - `Error BetaErrorUnion` - `type BetaInvalidRequestError struct{…}` - `Message string` - `Type InvalidRequestError` - `const InvalidRequestErrorInvalidRequestError InvalidRequestError = "invalid_request_error"` - `type BetaAuthenticationError struct{…}` - `Message string` - `Type AuthenticationError` - `const AuthenticationErrorAuthenticationError AuthenticationError = "authentication_error"` - `type BetaBillingError struct{…}` - `Message string` - `Type BillingError` - `const BillingErrorBillingError BillingError = "billing_error"` - `type BetaPermissionError struct{…}` - `Message string` - `Type PermissionError` - `const PermissionErrorPermissionError PermissionError = "permission_error"` - `type BetaNotFoundError struct{…}` - `Message string` - `Type NotFoundError` - `const NotFoundErrorNotFoundError NotFoundError = "not_found_error"` - `type BetaRateLimitError struct{…}` - `Message string` - `Type RateLimitError` - `const RateLimitErrorRateLimitError RateLimitError = "rate_limit_error"` - `type BetaGatewayTimeoutError struct{…}` - `Message string` - `Type TimeoutError` - `const TimeoutErrorTimeoutError TimeoutError = "timeout_error"` - `type BetaAPIError struct{…}` - `Message string` - `Type APIError` - `const APIErrorAPIError APIError = "api_error"` - `type BetaOverloadedError struct{…}` - `Message string` - `Type OverloadedError` - `const OverloadedErrorOverloadedError OverloadedError = "overloaded_error"` - `RequestID string` - `Type Error` - `const ErrorError Error = "error"` - `Type Errored` - `const ErroredErrored Errored = "errored"` - `type BetaMessageBatchCanceledResult struct{…}` - `Type Canceled` - `const CanceledCanceled Canceled = "canceled"` - `type BetaMessageBatchExpiredResult struct{…}` - `Type Expired` - `const ExpiredExpired Expired = "expired"` ### Beta Message Batch Succeeded Result - `type BetaMessageBatchSucceededResult struct{…}` - `Message BetaMessage` - `ID string` Unique object identifier. The format and length of IDs may change over time. - `Container BetaContainer` Information about the container used in the request (for the code execution tool) - `ID string` Identifier for the container used in this request - `ExpiresAt Time` The time at which the container will expire. - `Skills []BetaSkill` Skills loaded in the container - `SkillID string` Skill ID - `Type BetaSkillType` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `const BetaSkillTypeAnthropic BetaSkillType = "anthropic"` - `const BetaSkillTypeCustom BetaSkillType = "custom"` - `Version string` Skill version or 'latest' for most recent version - `Content []BetaContentBlockUnion` Content generated by the model. This is an array of content blocks, each of which has a `type` that determines its shape. Example: ```json [{"type": "text", "text": "Hi, I'm Claude."}] ``` If the request input `messages` ended with an `assistant` turn, then the response `content` will continue directly from that last turn. You can use this to constrain the model's output. For example, if the input `messages` were: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("} ] ``` Then the response `content` might be: ```json [{"type": "text", "text": "B)"}] ``` - `type BetaTextBlock struct{…}` - `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`. - `type BetaCitationCharLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` - `Type CharLocation` - `const CharLocationCharLocation CharLocation = "char_location"` - `type BetaCitationPageLocation struct{…}` - `CitedText string` - `DocumentIndex int64` - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` - `Type PageLocation` - `const PageLocationPageLocation PageLocation = "page_location"` - `type BetaCitationContentBlockLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` - `DocumentTitle string` - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Type ContentBlockLocation` - `const ContentBlockLocationContentBlockLocation ContentBlockLocation = "content_block_location"` - `type BetaCitationsWebSearchResultLocation struct{…}` - `CitedText string` - `EncryptedIndex string` - `Title string` - `Type WebSearchResultLocation` - `const WebSearchResultLocationWebSearchResultLocation WebSearchResultLocation = "web_search_result_location"` - `URL string` - `type BetaCitationSearchResultLocation struct{…}` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `SearchResultIndex int64` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. - `Title string` - `Type SearchResultLocation` - `const SearchResultLocationSearchResultLocation SearchResultLocation = "search_result_location"` - `Text string` - `Type Text` - `const TextText Text = "text"` - `type BetaThinkingBlock struct{…}` - `Signature string` - `Thinking string` - `Type Thinking` - `const ThinkingThinking Thinking = "thinking"` - `type BetaRedactedThinkingBlock struct{…}` - `Data string` - `Type RedactedThinking` - `const RedactedThinkingRedactedThinking RedactedThinking = "redacted_thinking"` - `type BetaToolUseBlock struct{…}` - `ID string` - `Input map[string, any]` - `Name string` - `Type ToolUse` - `const ToolUseToolUse ToolUse = "tool_use"` - `Caller BetaToolUseBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `Type Direct` - `const DirectDirect Direct = "direct"` - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `ToolID string` - `Type CodeExecution20250825` - `const CodeExecution20250825CodeExecution20250825 CodeExecution20250825 = "code_execution_20250825"` - `type BetaServerToolCaller20260120 struct{…}` - `ToolID string` - `Type CodeExecution20260120` - `const CodeExecution20260120CodeExecution20260120 CodeExecution20260120 = "code_execution_20260120"` - `type BetaServerToolUseBlock struct{…}` - `ID string` - `Input map[string, any]` - `Name BetaServerToolUseBlockName` - `const BetaServerToolUseBlockNameAdvisor BetaServerToolUseBlockName = "advisor"` - `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` - `const ServerToolUseServerToolUse ServerToolUse = "server_tool_use"` - `Caller BetaServerToolUseBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebSearchToolResultBlock struct{…}` - `Content BetaWebSearchToolResultBlockContentUnion` - `type BetaWebSearchToolResultError struct{…}` - `ErrorCode BetaWebSearchToolResultErrorCode` - `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` - `const WebSearchToolResultErrorWebSearchToolResultError WebSearchToolResultError = "web_search_tool_result_error"` - `type BetaWebSearchToolResultBlockContentArray []BetaWebSearchResultBlock` - `EncryptedContent string` - `PageAge string` - `Title string` - `Type WebSearchResult` - `const WebSearchResultWebSearchResult WebSearchResult = "web_search_result"` - `URL string` - `ToolUseID string` - `Type WebSearchToolResult` - `const WebSearchToolResultWebSearchToolResult WebSearchToolResult = "web_search_tool_result"` - `Caller BetaWebSearchToolResultBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaWebFetchToolResultBlock struct{…}` - `Content BetaWebFetchToolResultBlockContentUnion` - `type BetaWebFetchToolResultErrorBlock struct{…}` - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `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` - `const WebFetchToolResultErrorWebFetchToolResultError WebFetchToolResultError = "web_fetch_tool_result_error"` - `type BetaWebFetchBlock struct{…}` - `Content BetaDocumentBlock` - `Citations BetaCitationConfig` Citation configuration for the document - `Enabled bool` - `Source BetaDocumentBlockSourceUnion` - `type BetaBase64PDFSource struct{…}` - `Data string` - `MediaType ApplicationPDF` - `const ApplicationPDFApplicationPDF ApplicationPDF = "application/pdf"` - `Type Base64` - `const Base64Base64 Base64 = "base64"` - `type BetaPlainTextSource struct{…}` - `Data string` - `MediaType TextPlain` - `const TextPlainTextPlain TextPlain = "text/plain"` - `Type Text` - `const TextText Text = "text"` - `Title string` The title of the document - `Type Document` - `const DocumentDocument Document = "document"` - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved - `Type WebFetchResult` - `const WebFetchResultWebFetchResult WebFetchResult = "web_fetch_result"` - `URL string` Fetched content URL - `ToolUseID string` - `Type WebFetchToolResult` - `const WebFetchToolResultWebFetchToolResult WebFetchToolResult = "web_fetch_tool_result"` - `Caller BetaWebFetchToolResultBlockCallerUnion` Tool invocation directly from the model. - `type BetaDirectCaller struct{…}` Tool invocation directly from the model. - `type BetaServerToolCaller struct{…}` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120 struct{…}` - `type BetaAdvisorToolResultBlock struct{…}` - `Content BetaAdvisorToolResultBlockContentUnion` - `type BetaAdvisorToolResultError struct{…}` - `ErrorCode BetaAdvisorToolResultErrorErrorCode` - `const BetaAdvisorToolResultErrorErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodePromptTooLong BetaAdvisorToolResultErrorErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorErrorCodeTooManyRequests BetaAdvisorToolResultErrorErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorErrorCodeOverloaded BetaAdvisorToolResultErrorErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorErrorCodeUnavailable BetaAdvisorToolResultErrorErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorErrorCode = "execution_time_exceeded"` - `Type AdvisorToolResultError` - `const AdvisorToolResultErrorAdvisorToolResultError AdvisorToolResultError = "advisor_tool_result_error"` - `type BetaAdvisorResultBlock struct{…}` - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `Text string` - `Type AdvisorResult` - `const AdvisorResultAdvisorResult AdvisorResult = "advisor_result"` - `type BetaAdvisorRedactedResultBlock struct{…}` - `EncryptedContent string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `Type AdvisorRedactedResult` - `const AdvisorRedactedResultAdvisorRedactedResult AdvisorRedactedResult = "advisor_redacted_result"` - `ToolUseID string` - `Type AdvisorToolResult` - `const AdvisorToolResultAdvisorToolResult AdvisorToolResult = "advisor_tool_result"` - `type BetaCodeExecutionToolResultBlock struct{…}` - `Content BetaCodeExecutionToolResultBlockContentUnion` Code execution result with encrypted stdout for PFC + web_search results. - `type BetaCodeExecutionToolResultError struct{…}` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `Type CodeExecutionToolResultError` - `const CodeExecutionToolResultErrorCodeExecutionToolResultError CodeExecutionToolResultError = "code_execution_tool_result_error"` - `type BetaCodeExecutionResultBlock struct{…}` - `Content []BetaCodeExecutionOutputBlock` - `FileID string` - `Type CodeExecutionOutput` - `const CodeExecutionOutputCodeExecutionOutput CodeExecutionOutput = "code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type CodeExecutionResult` - `const CodeExecutionResultCodeExecutionResult CodeExecutionResult = "code_execution_result"` - `type BetaEncryptedCodeExecutionResultBlock struct{…}` Code execution result with encrypted stdout for PFC + web_search results. - `Content []BetaCodeExecutionOutputBlock` - `FileID string` - `Type CodeExecutionOutput` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `Type EncryptedCodeExecutionResult` - `const EncryptedCodeExecutionResultEncryptedCodeExecutionResult EncryptedCodeExecutionResult = "encrypted_code_execution_result"` - `ToolUseID string` - `Type CodeExecutionToolResult` - `const CodeExecutionToolResultCodeExecutionToolResult CodeExecutionToolResult = "code_execution_tool_result"` - `type BetaBashCodeExecutionToolResultBlock struct{…}` - `Content BetaBashCodeExecutionToolResultBlockContentUnion` - `type BetaBashCodeExecutionToolResultError struct{…}` - `ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode` - `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` - `const BashCodeExecutionToolResultErrorBashCodeExecutionToolResultError BashCodeExecutionToolResultError = "bash_code_execution_tool_result_error"` - `type BetaBashCodeExecutionResultBlock struct{…}` - `Content []BetaBashCodeExecutionOutputBlock` - `FileID string` - `Type BashCodeExecutionOutput` - `const BashCodeExecutionOutputBashCodeExecutionOutput BashCodeExecutionOutput = "bash_code_execution_output"` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `Type BashCodeExecutionResult` - `const BashCodeExecutionResultBashCodeExecutionResult BashCodeExecutionResult = "bash_code_execution_result"` - `ToolUseID string` - `Type BashCodeExecutionToolResult` - `const BashCodeExecutionToolResultBashCodeExecutionToolResult BashCodeExecutionToolResult = "bash_code_execution_tool_result"` - `type BetaTextEditorCodeExecutionToolResultBlock struct{…}` - `Content BetaTextEditorCodeExecutionToolResultBlockContentUnion` - `type BetaTextEditorCodeExecutionToolResultError struct{…}` - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode` - `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` - `const TextEditorCodeExecutionToolResultErrorTextEditorCodeExecutionToolResultError TextEditorCodeExecutionToolResultError = "text_editor_code_execution_tool_result_error"` - `type BetaTextEditorCodeExecutionViewResultBlock struct{…}` - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockFileType` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` - `Type TextEditorCodeExecutionViewResult` - `const TextEditorCodeExecutionViewResultTextEditorCodeExecutionViewResult TextEditorCodeExecutionViewResult = "text_editor_code_execution_view_result"` - `type BetaTextEditorCodeExecutionCreateResultBlock struct{…}` - `IsFileUpdate bool` - `Type TextEditorCodeExecutionCreateResult` - `const TextEditorCodeExecutionCreateResultTextEditorCodeExecutionCreateResult TextEditorCodeExecutionCreateResult = "text_editor_code_execution_create_result"` - `type BetaTextEditorCodeExecutionStrReplaceResultBlock struct{…}` - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` - `Type TextEditorCodeExecutionStrReplaceResult` - `const TextEditorCodeExecutionStrReplaceResultTextEditorCodeExecutionStrReplaceResult TextEditorCodeExecutionStrReplaceResult = "text_editor_code_execution_str_replace_result"` - `ToolUseID string` - `Type TextEditorCodeExecutionToolResult` - `const TextEditorCodeExecutionToolResultTextEditorCodeExecutionToolResult TextEditorCodeExecutionToolResult = "text_editor_code_execution_tool_result"` - `type BetaToolSearchToolResultBlock struct{…}` - `Content BetaToolSearchToolResultBlockContentUnion` - `type BetaToolSearchToolResultError struct{…}` - `ErrorCode BetaToolSearchToolResultErrorErrorCode` - `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` - `const ToolSearchToolResultErrorToolSearchToolResultError ToolSearchToolResultError = "tool_search_tool_result_error"` - `type BetaToolSearchToolSearchResultBlock struct{…}` - `ToolReferences []BetaToolReferenceBlock` - `ToolName string` - `Type ToolReference` - `const ToolReferenceToolReference ToolReference = "tool_reference"` - `Type ToolSearchToolSearchResult` - `const ToolSearchToolSearchResultToolSearchToolSearchResult ToolSearchToolSearchResult = "tool_search_tool_search_result"` - `ToolUseID string` - `Type ToolSearchToolResult` - `const ToolSearchToolResultToolSearchToolResult ToolSearchToolResult = "tool_search_tool_result"` - `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` - `const MCPToolUseMCPToolUse MCPToolUse = "mcp_tool_use"` - `type BetaMCPToolResultBlock struct{…}` - `Content BetaMCPToolResultBlockContentUnion` - `string` - `type BetaMCPToolResultBlockContentBetaMCPToolResultBlockContent []BetaTextBlock` - `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`. - `Text string` - `Type Text` - `IsError bool` - `ToolUseID string` - `Type MCPToolResult` - `const MCPToolResultMCPToolResult MCPToolResult = "mcp_tool_result"` - `type BetaContainerUploadBlock struct{…}` Response model for a file uploaded to the container. - `FileID string` - `Type ContainerUpload` - `const ContainerUploadContainerUpload ContainerUpload = "container_upload"` - `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 - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `Type Compaction` - `const CompactionCompaction Compaction = "compaction"` - `ContextManagement BetaContextManagementResponse` Context management response. Information about context management strategies applied during the request. - `AppliedEdits []BetaContextManagementResponseAppliedEditUnion` List of context management edits that were applied. - `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. - `const ClearToolUses20250919ClearToolUses20250919 ClearToolUses20250919 = "clear_tool_uses_20250919"` - `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. - `const ClearThinking20251015ClearThinking20251015 ClearThinking20251015 = "clear_thinking_20251015"` - `Diagnostics BetaDiagnostics` Response envelope for request-level diagnostics. Present (possibly null) whenever the caller supplied `diagnostics` on the request. - `CacheMissReason BetaDiagnosticsCacheMissReasonUnion` Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - `type BetaCacheMissModelChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type ModelChanged` - `const ModelChangedModelChanged ModelChanged = "model_changed"` - `type BetaCacheMissSystemChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type SystemChanged` - `const SystemChangedSystemChanged SystemChanged = "system_changed"` - `type BetaCacheMissToolsChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type ToolsChanged` - `const ToolsChangedToolsChanged ToolsChanged = "tools_changed"` - `type BetaCacheMissMessagesChanged struct{…}` - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `Type MessagesChanged` - `const MessagesChangedMessagesChanged MessagesChanged = "messages_changed"` - `type BetaCacheMissPreviousMessageNotFound struct{…}` - `Type PreviousMessageNotFound` - `const PreviousMessageNotFoundPreviousMessageNotFound PreviousMessageNotFound = "previous_message_not_found"` - `type BetaCacheMissUnavailable struct{…}` - `Type Unavailable` - `const UnavailableUnavailable Unavailable = "unavailable"` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type Model string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `const ModelClaudeOpus4_1 Model = "claude-opus-4-1"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_1_20250805 Model = "claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `const ModelClaudeOpus4_0 Model = "claude-opus-4-0"` Powerful model for complex tasks - `const ModelClaudeOpus4_20250514 Model = "claude-opus-4-20250514"` Powerful model for complex tasks - `const ModelClaudeSonnet4_0 Model = "claude-sonnet-4-0"` High-performance model with extended thinking - `const ModelClaudeSonnet4_20250514 Model = "claude-sonnet-4-20250514"` High-performance model with extended thinking - `const ModelClaude_3_Haiku_20240307 Model = "claude-3-haiku-20240307"` Fast and cost-effective model - `string` - `Role Assistant` Conversational role of the generated message. This will always be `"assistant"`. - `const AssistantAssistant Assistant = "assistant"` - `StopDetails BetaRefusalStopDetails` Structured information about a refusal. - `Category BetaRefusalStopDetailsCategory` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `const BetaRefusalStopDetailsCategoryCyber BetaRefusalStopDetailsCategory = "cyber"` - `const BetaRefusalStopDetailsCategoryBio BetaRefusalStopDetailsCategory = "bio"` - `Explanation string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `Type Refusal` - `const RefusalRefusal Refusal = "refusal"` - `StopReason BetaStopReason` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `const BetaStopReasonEndTurn BetaStopReason = "end_turn"` - `const BetaStopReasonMaxTokens BetaStopReason = "max_tokens"` - `const BetaStopReasonStopSequence BetaStopReason = "stop_sequence"` - `const BetaStopReasonToolUse BetaStopReason = "tool_use"` - `const BetaStopReasonPauseTurn BetaStopReason = "pause_turn"` - `const BetaStopReasonCompaction BetaStopReason = "compaction"` - `const BetaStopReasonRefusal BetaStopReason = "refusal"` - `const BetaStopReasonModelContextWindowExceeded BetaStopReason = "model_context_window_exceeded"` - `StopSequence string` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `Type Message` Object type. For Messages, this is always `"message"`. - `const MessageMessage Message = "message"` - `Usage BetaUsage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `CacheCreation 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. - `InferenceGeo string` The geographic region where inference was performed for this request. - `InputTokens int64` The number of input tokens which were used. - `Iterations BetaIterationsUsage` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the true context window size from the last iteration - Understand token accumulation across server-side tool use loops - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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 Message` Usage for a sampling iteration - `const MessageMessage Message = "message"` - `type BetaCompactionIterationUsage struct{…}` Token usage for a compaction iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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 - `const CompactionCompaction Compaction = "compaction"` - `type BetaAdvisorMessageIterationUsage struct{…}` Token usage for an advisor sub-inference iteration. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `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. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. - `Type AdvisorMessage` Usage for an advisor sub-inference iteration - `const AdvisorMessageAdvisorMessage AdvisorMessage = "advisor_message"` - `OutputTokens int64` The number of output tokens which were used. - `OutputTokensDetails BetaOutputTokensDetails` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `ThinkingTokens int64` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. - `ServerToolUse BetaServerToolUsage` The number of server tool requests. - `WebFetchRequests int64` The number of web fetch tool requests. - `WebSearchRequests int64` The number of web search tool requests. - `ServiceTier BetaUsageServiceTier` If the request used the priority, standard, or batch tier. - `const BetaUsageServiceTierStandard BetaUsageServiceTier = "standard"` - `const BetaUsageServiceTierPriority BetaUsageServiceTier = "priority"` - `const BetaUsageServiceTierBatch BetaUsageServiceTier = "batch"` - `Speed BetaUsageSpeed` The inference speed mode used for this request. - `const BetaUsageSpeedStandard BetaUsageSpeed = "standard"` - `const BetaUsageSpeedFast BetaUsageSpeed = "fast"` - `Type Succeeded` - `const SucceededSucceeded Succeeded = "succeeded"` # Agents ## Create Agent `client.Beta.Agents.New(ctx, params) (*BetaManagedAgentsAgent, error)` **post** `/v1/agents` Create Agent ### Parameters - `params BetaAgentNewParams` - `Model param.Field[BetaManagedAgentsModelConfigParamsResp]` Body param: Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison), e.g. `claude-opus-4-6`, or a `model_config` object for additional configuration control - `type BetaManagedAgentsModelConfigParamsResp struct{…}` An object that defines additional configuration control over model use - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigParamsSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigParamsSpeedStandard BetaManagedAgentsModelConfigParamsSpeed = "standard"` - `const BetaManagedAgentsModelConfigParamsSpeedFast BetaManagedAgentsModelConfigParamsSpeed = "fast"` - `Name param.Field[string]` Body param: Human-readable name for the agent. 1-256 characters. - `Description param.Field[string]` Body param: Description of what the agent does. Up to 2048 characters. - `MCPServers param.Field[[]BetaManagedAgentsURLMCPServerParamsResp]` Body param: MCP servers this agent connects to. Maximum 20. Names must be unique within the array. - `Name string` Unique name for this server, referenced by mcp_toolset configurations. 1-255 characters. - `Type BetaManagedAgentsURLMCPServerParamsType` - `const BetaManagedAgentsURLMCPServerParamsTypeURL BetaManagedAgentsURLMCPServerParamsType = "url"` - `URL string` Endpoint URL for the MCP server. - `Metadata param.Field[map[string, string]]` Body param: Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `Multiagent param.Field[BetaManagedAgentsMultiagentParamsResp]` Body param: A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the `agents` roster. - `Skills param.Field[[]BetaManagedAgentsSkillParamsUnionResp]` Body param: Skills available to the agent. Maximum 20. - `type BetaManagedAgentsAnthropicSkillParamsResp struct{…}` An Anthropic-managed skill. - `SkillID string` Identifier of the Anthropic skill (e.g., "xlsx"). - `Type BetaManagedAgentsAnthropicSkillParamsType` - `const BetaManagedAgentsAnthropicSkillParamsTypeAnthropic BetaManagedAgentsAnthropicSkillParamsType = "anthropic"` - `Version string` Version to pin. Defaults to latest if omitted. - `type BetaManagedAgentsCustomSkillParamsResp struct{…}` A user-created custom skill. - `SkillID string` Tagged ID of the custom skill (e.g., "skill_01XJ5..."). - `Type BetaManagedAgentsCustomSkillParamsType` - `const BetaManagedAgentsCustomSkillParamsTypeCustom BetaManagedAgentsCustomSkillParamsType = "custom"` - `Version string` Version to pin. Defaults to latest if omitted. - `System param.Field[string]` Body param: System prompt for the agent. Up to 100,000 characters. - `Tools param.Field[[]BetaAgentNewParamsToolUnion]` Body param: Tool configurations available to the agent. Maximum of 128 tools across all toolsets allowed. - `type BetaManagedAgentsAgentToolset20260401ParamsResp struct{…}` Configuration for built-in agent tools. Use this to enable or disable groups of tools available to the agent. - `Type BetaManagedAgentsAgentToolset20260401ParamsType` - `const BetaManagedAgentsAgentToolset20260401ParamsTypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401ParamsType = "agent_toolset_20260401"` - `Configs []BetaManagedAgentsAgentToolConfigParamsResp` Per-tool configuration overrides. - `Name BetaManagedAgentsAgentToolConfigParamsName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigParamsNameBash BetaManagedAgentsAgentToolConfigParamsName = "bash"` - `const BetaManagedAgentsAgentToolConfigParamsNameEdit BetaManagedAgentsAgentToolConfigParamsName = "edit"` - `const BetaManagedAgentsAgentToolConfigParamsNameRead BetaManagedAgentsAgentToolConfigParamsName = "read"` - `const BetaManagedAgentsAgentToolConfigParamsNameWrite BetaManagedAgentsAgentToolConfigParamsName = "write"` - `const BetaManagedAgentsAgentToolConfigParamsNameGlob BetaManagedAgentsAgentToolConfigParamsName = "glob"` - `const BetaManagedAgentsAgentToolConfigParamsNameGrep BetaManagedAgentsAgentToolConfigParamsName = "grep"` - `const BetaManagedAgentsAgentToolConfigParamsNameWebFetch BetaManagedAgentsAgentToolConfigParamsName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigParamsNameWebSearch BetaManagedAgentsAgentToolConfigParamsName = "web_search"` - `Enabled bool` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `PermissionPolicy BetaManagedAgentsAgentToolConfigParamsPermissionPolicyUnionResp` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfigParamsResp` Default configuration for all tools in a toolset. - `Enabled bool` Whether tools are enabled and available to Claude by default. Defaults to true if not specified. - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigParamsPermissionPolicyUnionResp` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `type BetaManagedAgentsMCPToolsetParamsResp struct{…}` Configuration for tools from an MCP server defined in `mcp_servers`. - `MCPServerName string` Name of the MCP server. Must match a server name from the mcp_servers array. 1-255 characters. - `Type BetaManagedAgentsMCPToolsetParamsType` - `const BetaManagedAgentsMCPToolsetParamsTypeMCPToolset BetaManagedAgentsMCPToolsetParamsType = "mcp_toolset"` - `Configs []BetaManagedAgentsMCPToolConfigParamsResp` Per-tool configuration overrides. - `Name string` Name of the MCP tool to configure. 1-128 characters. - `Enabled bool` Whether this tool is enabled. Overrides the `default_config` setting. - `PermissionPolicy BetaManagedAgentsMCPToolConfigParamsPermissionPolicyUnionResp` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfigParamsResp` Default configuration for all tools from an MCP server. - `Enabled bool` Whether tools are enabled by default. Defaults to true if not specified. - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigParamsPermissionPolicyUnionResp` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `type BetaManagedAgentsCustomToolParamsResp struct{…}` A custom tool that is executed by the API client rather than the agent. When the agent calls this tool, an `agent.custom_tool_use` event is emitted and the session goes idle, waiting for the client to provide the result via a `user.custom_tool_result` event. - `Description string` Description of what the tool does, shown to the agent to help it decide when to use the tool. 1-1024 characters. - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` Unique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens. - `Type BetaManagedAgentsCustomToolParamsType` - `const BetaManagedAgentsCustomToolParamsTypeCustom BetaManagedAgentsCustomToolParamsType = "custom"` - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsAgent struct{…}` A Managed Agents `agent`. - `ID string` - `ArchivedAt Time` A timestamp in RFC 3339 format - `CreatedAt Time` A timestamp in RFC 3339 format - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Metadata map[string, string]` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Multiagent BetaManagedAgentsMultiagent` Resolved coordinator topology with a concrete agent roster. - `Agents []BetaManagedAgentsAgentReference` Agents the coordinator may spawn as session threads, each resolved to a specific version. - `ID string` - `Type BetaManagedAgentsAgentReferenceType` - `const BetaManagedAgentsAgentReferenceTypeAgent BetaManagedAgentsAgentReferenceType = "agent"` - `Version int64` - `Type BetaManagedAgentsMultiagentType` - `const BetaManagedAgentsMultiagentTypeCoordinator BetaManagedAgentsMultiagentType = "coordinator"` - `Name string` - `Skills []BetaManagedAgentsAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsAgentType` - `const BetaManagedAgentsAgentTypeAgent BetaManagedAgentsAgentType = "agent"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `Version int64` The agent's current version. Starts at 1 and increments when the agent is modified. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsAgent, err := client.Beta.Agents.New(context.TODO(), anthropic.BetaAgentNewParams{ Model: anthropic.BetaManagedAgentsModelConfigParams{ ID: anthropic.BetaManagedAgentsModelClaudeOpus4_6, }, Name: "My First Agent", }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsAgent.ID) } ``` #### Response ```json { "id": "agent_011CZkYpogX7uDKUyvBTophP", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "metadata": { "foo": "bar" }, "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "updated_at": "2026-03-15T10:00:00Z", "version": 1 } ``` ## List Agents `client.Beta.Agents.List(ctx, params) (*PageCursor[BetaManagedAgentsAgent], error)` **get** `/v1/agents` List Agents ### Parameters - `params BetaAgentListParams` - `CreatedAtGte param.Field[Time]` Query param: Return agents created at or after this time (inclusive). - `CreatedAtLte param.Field[Time]` Query param: Return agents created at or before this time (inclusive). - `IncludeArchived param.Field[bool]` Query param: Include archived agents in results. Defaults to false. - `Limit param.Field[int64]` Query param: Maximum results per page. Default 20, maximum 100. - `Page param.Field[string]` Query param: Opaque pagination cursor from a previous response. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsAgent struct{…}` A Managed Agents `agent`. - `ID string` - `ArchivedAt Time` A timestamp in RFC 3339 format - `CreatedAt Time` A timestamp in RFC 3339 format - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Metadata map[string, string]` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Multiagent BetaManagedAgentsMultiagent` Resolved coordinator topology with a concrete agent roster. - `Agents []BetaManagedAgentsAgentReference` Agents the coordinator may spawn as session threads, each resolved to a specific version. - `ID string` - `Type BetaManagedAgentsAgentReferenceType` - `const BetaManagedAgentsAgentReferenceTypeAgent BetaManagedAgentsAgentReferenceType = "agent"` - `Version int64` - `Type BetaManagedAgentsMultiagentType` - `const BetaManagedAgentsMultiagentTypeCoordinator BetaManagedAgentsMultiagentType = "coordinator"` - `Name string` - `Skills []BetaManagedAgentsAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsAgentType` - `const BetaManagedAgentsAgentTypeAgent BetaManagedAgentsAgentType = "agent"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `Version int64` The agent's current version. Starts at 1 and increments when the agent is modified. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) page, err := client.Beta.Agents.List(context.TODO(), anthropic.BetaAgentListParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "data": [ { "id": "agent_011CZkYpogX7uDKUyvBTophP", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "metadata": { "foo": "bar" }, "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "updated_at": "2026-03-15T10:00:00Z", "version": 1 } ], "next_page": "next_page" } ``` ## Get Agent `client.Beta.Agents.Get(ctx, agentID, params) (*BetaManagedAgentsAgent, error)` **get** `/v1/agents/{agent_id}` Get Agent ### Parameters - `agentID string` - `params BetaAgentGetParams` - `Version param.Field[int64]` Query param: Agent version. Omit for the most recent version. Must be at least 1 if specified. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsAgent struct{…}` A Managed Agents `agent`. - `ID string` - `ArchivedAt Time` A timestamp in RFC 3339 format - `CreatedAt Time` A timestamp in RFC 3339 format - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Metadata map[string, string]` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Multiagent BetaManagedAgentsMultiagent` Resolved coordinator topology with a concrete agent roster. - `Agents []BetaManagedAgentsAgentReference` Agents the coordinator may spawn as session threads, each resolved to a specific version. - `ID string` - `Type BetaManagedAgentsAgentReferenceType` - `const BetaManagedAgentsAgentReferenceTypeAgent BetaManagedAgentsAgentReferenceType = "agent"` - `Version int64` - `Type BetaManagedAgentsMultiagentType` - `const BetaManagedAgentsMultiagentTypeCoordinator BetaManagedAgentsMultiagentType = "coordinator"` - `Name string` - `Skills []BetaManagedAgentsAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsAgentType` - `const BetaManagedAgentsAgentTypeAgent BetaManagedAgentsAgentType = "agent"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `Version int64` The agent's current version. Starts at 1 and increments when the agent is modified. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsAgent, err := client.Beta.Agents.Get( context.TODO(), "agent_011CZkYpogX7uDKUyvBTophP", anthropic.BetaAgentGetParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsAgent.ID) } ``` #### Response ```json { "id": "agent_011CZkYpogX7uDKUyvBTophP", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "metadata": { "foo": "bar" }, "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "updated_at": "2026-03-15T10:00:00Z", "version": 1 } ``` ## Update Agent `client.Beta.Agents.Update(ctx, agentID, params) (*BetaManagedAgentsAgent, error)` **post** `/v1/agents/{agent_id}` Update Agent ### Parameters - `agentID string` - `params BetaAgentUpdateParams` - `Version param.Field[int64]` Body param: The agent's current version, used to prevent concurrent overwrites. Obtain this value from a create or retrieve response. The request fails if this does not match the server's current version. - `Description param.Field[string]` Body param: Description. Up to 2048 characters. Omit to preserve; send empty string or null to clear. - `MCPServers param.Field[[]BetaManagedAgentsURLMCPServerParamsResp]` Body param: MCP servers. Full replacement. Omit to preserve; send empty array or null to clear. Names must be unique. Maximum 20. - `Name string` Unique name for this server, referenced by mcp_toolset configurations. 1-255 characters. - `Type BetaManagedAgentsURLMCPServerParamsType` - `const BetaManagedAgentsURLMCPServerParamsTypeURL BetaManagedAgentsURLMCPServerParamsType = "url"` - `URL string` Endpoint URL for the MCP server. - `Metadata param.Field[map[string, string]]` Body param: Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve. The stored bag is limited to 16 keys (up to 64 chars each) with values up to 512 chars. - `Model param.Field[BetaManagedAgentsModelConfigParamsResp]` Body param: Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison), e.g. `claude-opus-4-6`, or a `model_config` object for additional configuration control. Omit to preserve. Cannot be cleared. - `type BetaManagedAgentsModelConfigParamsResp struct{…}` An object that defines additional configuration control over model use - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigParamsSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigParamsSpeedStandard BetaManagedAgentsModelConfigParamsSpeed = "standard"` - `const BetaManagedAgentsModelConfigParamsSpeedFast BetaManagedAgentsModelConfigParamsSpeed = "fast"` - `Multiagent param.Field[BetaManagedAgentsMultiagentParamsResp]` Body param: A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the `agents` roster. - `Name param.Field[string]` Body param: Human-readable name. 1-256 characters. Omit to preserve. Cannot be cleared. - `Skills param.Field[[]BetaManagedAgentsSkillParamsUnionResp]` Body param: Skills. Full replacement. Omit to preserve; send empty array or null to clear. Maximum 20. - `type BetaManagedAgentsAnthropicSkillParamsResp struct{…}` An Anthropic-managed skill. - `SkillID string` Identifier of the Anthropic skill (e.g., "xlsx"). - `Type BetaManagedAgentsAnthropicSkillParamsType` - `const BetaManagedAgentsAnthropicSkillParamsTypeAnthropic BetaManagedAgentsAnthropicSkillParamsType = "anthropic"` - `Version string` Version to pin. Defaults to latest if omitted. - `type BetaManagedAgentsCustomSkillParamsResp struct{…}` A user-created custom skill. - `SkillID string` Tagged ID of the custom skill (e.g., "skill_01XJ5..."). - `Type BetaManagedAgentsCustomSkillParamsType` - `const BetaManagedAgentsCustomSkillParamsTypeCustom BetaManagedAgentsCustomSkillParamsType = "custom"` - `Version string` Version to pin. Defaults to latest if omitted. - `System param.Field[string]` Body param: System prompt. Up to 100,000 characters. Omit to preserve; send empty string or null to clear. - `Tools param.Field[[]BetaAgentUpdateParamsToolUnion]` Body param: Tool configurations available to the agent. Full replacement. Omit to preserve; send empty array or null to clear. Maximum of 128 tools across all toolsets allowed. - `type BetaManagedAgentsAgentToolset20260401ParamsResp struct{…}` Configuration for built-in agent tools. Use this to enable or disable groups of tools available to the agent. - `Type BetaManagedAgentsAgentToolset20260401ParamsType` - `const BetaManagedAgentsAgentToolset20260401ParamsTypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401ParamsType = "agent_toolset_20260401"` - `Configs []BetaManagedAgentsAgentToolConfigParamsResp` Per-tool configuration overrides. - `Name BetaManagedAgentsAgentToolConfigParamsName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigParamsNameBash BetaManagedAgentsAgentToolConfigParamsName = "bash"` - `const BetaManagedAgentsAgentToolConfigParamsNameEdit BetaManagedAgentsAgentToolConfigParamsName = "edit"` - `const BetaManagedAgentsAgentToolConfigParamsNameRead BetaManagedAgentsAgentToolConfigParamsName = "read"` - `const BetaManagedAgentsAgentToolConfigParamsNameWrite BetaManagedAgentsAgentToolConfigParamsName = "write"` - `const BetaManagedAgentsAgentToolConfigParamsNameGlob BetaManagedAgentsAgentToolConfigParamsName = "glob"` - `const BetaManagedAgentsAgentToolConfigParamsNameGrep BetaManagedAgentsAgentToolConfigParamsName = "grep"` - `const BetaManagedAgentsAgentToolConfigParamsNameWebFetch BetaManagedAgentsAgentToolConfigParamsName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigParamsNameWebSearch BetaManagedAgentsAgentToolConfigParamsName = "web_search"` - `Enabled bool` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `PermissionPolicy BetaManagedAgentsAgentToolConfigParamsPermissionPolicyUnionResp` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfigParamsResp` Default configuration for all tools in a toolset. - `Enabled bool` Whether tools are enabled and available to Claude by default. Defaults to true if not specified. - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigParamsPermissionPolicyUnionResp` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `type BetaManagedAgentsMCPToolsetParamsResp struct{…}` Configuration for tools from an MCP server defined in `mcp_servers`. - `MCPServerName string` Name of the MCP server. Must match a server name from the mcp_servers array. 1-255 characters. - `Type BetaManagedAgentsMCPToolsetParamsType` - `const BetaManagedAgentsMCPToolsetParamsTypeMCPToolset BetaManagedAgentsMCPToolsetParamsType = "mcp_toolset"` - `Configs []BetaManagedAgentsMCPToolConfigParamsResp` Per-tool configuration overrides. - `Name string` Name of the MCP tool to configure. 1-128 characters. - `Enabled bool` Whether this tool is enabled. Overrides the `default_config` setting. - `PermissionPolicy BetaManagedAgentsMCPToolConfigParamsPermissionPolicyUnionResp` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfigParamsResp` Default configuration for all tools from an MCP server. - `Enabled bool` Whether tools are enabled by default. Defaults to true if not specified. - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigParamsPermissionPolicyUnionResp` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `type BetaManagedAgentsCustomToolParamsResp struct{…}` A custom tool that is executed by the API client rather than the agent. When the agent calls this tool, an `agent.custom_tool_use` event is emitted and the session goes idle, waiting for the client to provide the result via a `user.custom_tool_result` event. - `Description string` Description of what the tool does, shown to the agent to help it decide when to use the tool. 1-1024 characters. - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` Unique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens. - `Type BetaManagedAgentsCustomToolParamsType` - `const BetaManagedAgentsCustomToolParamsTypeCustom BetaManagedAgentsCustomToolParamsType = "custom"` - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsAgent struct{…}` A Managed Agents `agent`. - `ID string` - `ArchivedAt Time` A timestamp in RFC 3339 format - `CreatedAt Time` A timestamp in RFC 3339 format - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Metadata map[string, string]` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Multiagent BetaManagedAgentsMultiagent` Resolved coordinator topology with a concrete agent roster. - `Agents []BetaManagedAgentsAgentReference` Agents the coordinator may spawn as session threads, each resolved to a specific version. - `ID string` - `Type BetaManagedAgentsAgentReferenceType` - `const BetaManagedAgentsAgentReferenceTypeAgent BetaManagedAgentsAgentReferenceType = "agent"` - `Version int64` - `Type BetaManagedAgentsMultiagentType` - `const BetaManagedAgentsMultiagentTypeCoordinator BetaManagedAgentsMultiagentType = "coordinator"` - `Name string` - `Skills []BetaManagedAgentsAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsAgentType` - `const BetaManagedAgentsAgentTypeAgent BetaManagedAgentsAgentType = "agent"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `Version int64` The agent's current version. Starts at 1 and increments when the agent is modified. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsAgent, err := client.Beta.Agents.Update( context.TODO(), "agent_011CZkYpogX7uDKUyvBTophP", anthropic.BetaAgentUpdateParams{ Version: 1, }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsAgent.ID) } ``` #### Response ```json { "id": "agent_011CZkYpogX7uDKUyvBTophP", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "metadata": { "foo": "bar" }, "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "updated_at": "2026-03-15T10:00:00Z", "version": 1 } ``` ## Archive Agent `client.Beta.Agents.Archive(ctx, agentID, body) (*BetaManagedAgentsAgent, error)` **post** `/v1/agents/{agent_id}/archive` Archive Agent ### Parameters - `agentID string` - `body BetaAgentArchiveParams` - `Betas param.Field[[]AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsAgent struct{…}` A Managed Agents `agent`. - `ID string` - `ArchivedAt Time` A timestamp in RFC 3339 format - `CreatedAt Time` A timestamp in RFC 3339 format - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Metadata map[string, string]` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Multiagent BetaManagedAgentsMultiagent` Resolved coordinator topology with a concrete agent roster. - `Agents []BetaManagedAgentsAgentReference` Agents the coordinator may spawn as session threads, each resolved to a specific version. - `ID string` - `Type BetaManagedAgentsAgentReferenceType` - `const BetaManagedAgentsAgentReferenceTypeAgent BetaManagedAgentsAgentReferenceType = "agent"` - `Version int64` - `Type BetaManagedAgentsMultiagentType` - `const BetaManagedAgentsMultiagentTypeCoordinator BetaManagedAgentsMultiagentType = "coordinator"` - `Name string` - `Skills []BetaManagedAgentsAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsAgentType` - `const BetaManagedAgentsAgentTypeAgent BetaManagedAgentsAgentType = "agent"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `Version int64` The agent's current version. Starts at 1 and increments when the agent is modified. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsAgent, err := client.Beta.Agents.Archive( context.TODO(), "agent_011CZkYpogX7uDKUyvBTophP", anthropic.BetaAgentArchiveParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsAgent.ID) } ``` #### Response ```json { "id": "agent_011CZkYpogX7uDKUyvBTophP", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "metadata": { "foo": "bar" }, "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "updated_at": "2026-03-15T10:00:00Z", "version": 1 } ``` ## Domain Types ### Beta Managed Agents Agent - `type BetaManagedAgentsAgent struct{…}` A Managed Agents `agent`. - `ID string` - `ArchivedAt Time` A timestamp in RFC 3339 format - `CreatedAt Time` A timestamp in RFC 3339 format - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Metadata map[string, string]` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Multiagent BetaManagedAgentsMultiagent` Resolved coordinator topology with a concrete agent roster. - `Agents []BetaManagedAgentsAgentReference` Agents the coordinator may spawn as session threads, each resolved to a specific version. - `ID string` - `Type BetaManagedAgentsAgentReferenceType` - `const BetaManagedAgentsAgentReferenceTypeAgent BetaManagedAgentsAgentReferenceType = "agent"` - `Version int64` - `Type BetaManagedAgentsMultiagentType` - `const BetaManagedAgentsMultiagentTypeCoordinator BetaManagedAgentsMultiagentType = "coordinator"` - `Name string` - `Skills []BetaManagedAgentsAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsAgentType` - `const BetaManagedAgentsAgentTypeAgent BetaManagedAgentsAgentType = "agent"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `Version int64` The agent's current version. Starts at 1 and increments when the agent is modified. ### Beta Managed Agents Agent Reference - `type BetaManagedAgentsAgentReference struct{…}` A resolved agent reference with a concrete version. - `ID string` - `Type BetaManagedAgentsAgentReferenceType` - `const BetaManagedAgentsAgentReferenceTypeAgent BetaManagedAgentsAgentReferenceType = "agent"` - `Version int64` ### Beta Managed Agents Agent Tool Config - `type BetaManagedAgentsAgentToolConfig struct{…}` Configuration for a specific agent tool. - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` ### Beta Managed Agents Agent Tool Config Params - `type BetaManagedAgentsAgentToolConfigParamsResp struct{…}` Configuration override for a specific tool within a toolset. - `Name BetaManagedAgentsAgentToolConfigParamsName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigParamsNameBash BetaManagedAgentsAgentToolConfigParamsName = "bash"` - `const BetaManagedAgentsAgentToolConfigParamsNameEdit BetaManagedAgentsAgentToolConfigParamsName = "edit"` - `const BetaManagedAgentsAgentToolConfigParamsNameRead BetaManagedAgentsAgentToolConfigParamsName = "read"` - `const BetaManagedAgentsAgentToolConfigParamsNameWrite BetaManagedAgentsAgentToolConfigParamsName = "write"` - `const BetaManagedAgentsAgentToolConfigParamsNameGlob BetaManagedAgentsAgentToolConfigParamsName = "glob"` - `const BetaManagedAgentsAgentToolConfigParamsNameGrep BetaManagedAgentsAgentToolConfigParamsName = "grep"` - `const BetaManagedAgentsAgentToolConfigParamsNameWebFetch BetaManagedAgentsAgentToolConfigParamsName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigParamsNameWebSearch BetaManagedAgentsAgentToolConfigParamsName = "web_search"` - `Enabled bool` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `PermissionPolicy BetaManagedAgentsAgentToolConfigParamsPermissionPolicyUnionResp` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` ### Beta Managed Agents Agent Toolset Default Config - `type BetaManagedAgentsAgentToolsetDefaultConfig struct{…}` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` ### Beta Managed Agents Agent Toolset Default Config Params - `type BetaManagedAgentsAgentToolsetDefaultConfigParamsResp struct{…}` Default configuration for all tools in a toolset. - `Enabled bool` Whether tools are enabled and available to Claude by default. Defaults to true if not specified. - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigParamsPermissionPolicyUnionResp` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` ### Beta Managed Agents Agent Toolset20260401 - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` ### Beta Managed Agents Agent Toolset20260401 Bash Input - `type BetaManagedAgentsAgentToolset20260401BashInput struct{…}` Input payload for the `bash` tool of the `agent_toolset_20260401` toolset. All fields are optional; a normal invocation supplies `command`, while `restart=true` (with no `command`) reboots the runner-side bash session. - `Command string` Shell command to execute. Omit only when `restart` is true. - `Restart bool` When true, restart the persistent bash session instead of running a command. Subsequent calls without `restart` will run against the fresh session. - `TimeoutMs int64` Per-call timeout in milliseconds. Defaults to the runner-wide tool timeout when omitted or zero. ### Beta Managed Agents Agent Toolset20260401 Edit Input - `type BetaManagedAgentsAgentToolset20260401EditInput struct{…}` Input payload for the `edit` tool. Performs a string replacement in the named file; by default `old_string` must occur exactly once. - `FilePath string` Path of the file to edit. - `NewString string` Replacement text. - `OldString string` Substring to find and replace. - `ReplaceAll bool` When true, replace every occurrence of `old_string` instead of requiring a unique match. ### Beta Managed Agents Agent Toolset20260401 Glob Input - `type BetaManagedAgentsAgentToolset20260401GlobInput struct{…}` Input payload for the `glob` tool. Returns paths matching a doublestar glob pattern, newest first. - `Pattern string` Doublestar glob pattern (e.g. `**/*.go`). Absolute patterns are only permitted when the runner is configured to allow them. - `Path string` Optional directory root to search under. Defaults to the runner's working directory. ### Beta Managed Agents Agent Toolset20260401 Grep Input - `type BetaManagedAgentsAgentToolset20260401GrepInput struct{…}` Input payload for the `grep` tool. Searches file contents for a regular expression, returning matching lines. - `Pattern string` Regular expression to search for. - `Path string` Optional directory root to search under. Defaults to the runner's working directory. ### Beta Managed Agents Agent Toolset20260401 Params - `type BetaManagedAgentsAgentToolset20260401ParamsResp struct{…}` Configuration for built-in agent tools. Use this to enable or disable groups of tools available to the agent. - `Type BetaManagedAgentsAgentToolset20260401ParamsType` - `const BetaManagedAgentsAgentToolset20260401ParamsTypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401ParamsType = "agent_toolset_20260401"` - `Configs []BetaManagedAgentsAgentToolConfigParamsResp` Per-tool configuration overrides. - `Name BetaManagedAgentsAgentToolConfigParamsName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigParamsNameBash BetaManagedAgentsAgentToolConfigParamsName = "bash"` - `const BetaManagedAgentsAgentToolConfigParamsNameEdit BetaManagedAgentsAgentToolConfigParamsName = "edit"` - `const BetaManagedAgentsAgentToolConfigParamsNameRead BetaManagedAgentsAgentToolConfigParamsName = "read"` - `const BetaManagedAgentsAgentToolConfigParamsNameWrite BetaManagedAgentsAgentToolConfigParamsName = "write"` - `const BetaManagedAgentsAgentToolConfigParamsNameGlob BetaManagedAgentsAgentToolConfigParamsName = "glob"` - `const BetaManagedAgentsAgentToolConfigParamsNameGrep BetaManagedAgentsAgentToolConfigParamsName = "grep"` - `const BetaManagedAgentsAgentToolConfigParamsNameWebFetch BetaManagedAgentsAgentToolConfigParamsName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigParamsNameWebSearch BetaManagedAgentsAgentToolConfigParamsName = "web_search"` - `Enabled bool` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `PermissionPolicy BetaManagedAgentsAgentToolConfigParamsPermissionPolicyUnionResp` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfigParamsResp` Default configuration for all tools in a toolset. - `Enabled bool` Whether tools are enabled and available to Claude by default. Defaults to true if not specified. - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigParamsPermissionPolicyUnionResp` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. ### Beta Managed Agents Agent Toolset20260401 Read Input - `type BetaManagedAgentsAgentToolset20260401ReadInput struct{…}` Input payload for the `read` tool. Reads file contents relative to the runner's working directory (or absolute when the runner permits). - `FilePath string` Path of the file to read. - `ViewRange []int64` Optional `[start_line, end_line]` 1-indexed inclusive range. When omitted the entire file is returned. `end_line` of 0 or negative means "to end of file". ### Beta Managed Agents Agent Toolset20260401 Write Input - `type BetaManagedAgentsAgentToolset20260401WriteInput struct{…}` Input payload for the `write` tool. Writes (overwriting) the entire file contents. - `Content string` Full file contents to write. - `FilePath string` Path of the file to write. ### Beta Managed Agents Always Allow Policy - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` ### Beta Managed Agents Always Ask Policy - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` ### Beta Managed Agents Anthropic Skill - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` ### Beta Managed Agents Anthropic Skill Params - `type BetaManagedAgentsAnthropicSkillParamsResp struct{…}` An Anthropic-managed skill. - `SkillID string` Identifier of the Anthropic skill (e.g., "xlsx"). - `Type BetaManagedAgentsAnthropicSkillParamsType` - `const BetaManagedAgentsAnthropicSkillParamsTypeAnthropic BetaManagedAgentsAnthropicSkillParamsType = "anthropic"` - `Version string` Version to pin. Defaults to latest if omitted. ### Beta Managed Agents Custom Skill - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` ### Beta Managed Agents Custom Skill Params - `type BetaManagedAgentsCustomSkillParamsResp struct{…}` A user-created custom skill. - `SkillID string` Tagged ID of the custom skill (e.g., "skill_01XJ5..."). - `Type BetaManagedAgentsCustomSkillParamsType` - `const BetaManagedAgentsCustomSkillParamsTypeCustom BetaManagedAgentsCustomSkillParamsType = "custom"` - `Version string` Version to pin. Defaults to latest if omitted. ### Beta Managed Agents Custom Tool - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` ### Beta Managed Agents Custom Tool Input Schema - `type BetaManagedAgentsCustomToolInputSchema struct{…}` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` ### Beta Managed Agents Custom Tool Params - `type BetaManagedAgentsCustomToolParamsResp struct{…}` A custom tool that is executed by the API client rather than the agent. When the agent calls this tool, an `agent.custom_tool_use` event is emitted and the session goes idle, waiting for the client to provide the result via a `user.custom_tool_result` event. - `Description string` Description of what the tool does, shown to the agent to help it decide when to use the tool. 1-1024 characters. - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` Unique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens. - `Type BetaManagedAgentsCustomToolParamsType` - `const BetaManagedAgentsCustomToolParamsTypeCustom BetaManagedAgentsCustomToolParamsType = "custom"` ### Beta Managed Agents MCP Server URL Definition - `type BetaManagedAgentsMCPServerURLDefinition struct{…}` URL-based MCP server connection as returned in API responses. - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` ### Beta Managed Agents MCP Tool Config - `type BetaManagedAgentsMCPToolConfig struct{…}` Resolved configuration for a specific MCP tool. - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` ### Beta Managed Agents MCP Tool Config Params - `type BetaManagedAgentsMCPToolConfigParamsResp struct{…}` Configuration override for a specific MCP tool. - `Name string` Name of the MCP tool to configure. 1-128 characters. - `Enabled bool` Whether this tool is enabled. Overrides the `default_config` setting. - `PermissionPolicy BetaManagedAgentsMCPToolConfigParamsPermissionPolicyUnionResp` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` ### Beta Managed Agents MCP Toolset - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` ### Beta Managed Agents MCP Toolset Default Config - `type BetaManagedAgentsMCPToolsetDefaultConfig struct{…}` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` ### Beta Managed Agents MCP Toolset Default Config Params - `type BetaManagedAgentsMCPToolsetDefaultConfigParamsResp struct{…}` Default configuration for all tools from an MCP server. - `Enabled bool` Whether tools are enabled by default. Defaults to true if not specified. - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigParamsPermissionPolicyUnionResp` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` ### Beta Managed Agents MCP Toolset Params - `type BetaManagedAgentsMCPToolsetParamsResp struct{…}` Configuration for tools from an MCP server defined in `mcp_servers`. - `MCPServerName string` Name of the MCP server. Must match a server name from the mcp_servers array. 1-255 characters. - `Type BetaManagedAgentsMCPToolsetParamsType` - `const BetaManagedAgentsMCPToolsetParamsTypeMCPToolset BetaManagedAgentsMCPToolsetParamsType = "mcp_toolset"` - `Configs []BetaManagedAgentsMCPToolConfigParamsResp` Per-tool configuration overrides. - `Name string` Name of the MCP tool to configure. 1-128 characters. - `Enabled bool` Whether this tool is enabled. Overrides the `default_config` setting. - `PermissionPolicy BetaManagedAgentsMCPToolConfigParamsPermissionPolicyUnionResp` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfigParamsResp` Default configuration for all tools from an MCP server. - `Enabled bool` Whether tools are enabled by default. Defaults to true if not specified. - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigParamsPermissionPolicyUnionResp` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. ### Beta Managed Agents Model - `type BetaManagedAgentsModel interface{…}` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` ### Beta Managed Agents Model Config - `type BetaManagedAgentsModelConfig struct{…}` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` ### Beta Managed Agents Model Config Params - `type BetaManagedAgentsModelConfigParamsResp struct{…}` An object that defines additional configuration control over model use - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigParamsSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigParamsSpeedStandard BetaManagedAgentsModelConfigParamsSpeed = "standard"` - `const BetaManagedAgentsModelConfigParamsSpeedFast BetaManagedAgentsModelConfigParamsSpeed = "fast"` ### Beta Managed Agents Multiagent Coordinator - `type BetaManagedAgentsMultiagentCoordinator struct{…}` Resolved coordinator topology with a concrete agent roster. - `Agents []BetaManagedAgentsAgentReference` Agents the coordinator may spawn as session threads, each resolved to a specific version. - `ID string` - `Type BetaManagedAgentsAgentReferenceType` - `const BetaManagedAgentsAgentReferenceTypeAgent BetaManagedAgentsAgentReferenceType = "agent"` - `Version int64` - `Type BetaManagedAgentsMultiagentCoordinatorType` - `const BetaManagedAgentsMultiagentCoordinatorTypeCoordinator BetaManagedAgentsMultiagentCoordinatorType = "coordinator"` ### Beta Managed Agents Multiagent Coordinator Params - `type BetaManagedAgentsMultiagentCoordinatorParamsResp struct{…}` A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the `agents` roster. - `Agents []BetaManagedAgentsMultiagentRosterEntryParamsUnionResp` Agents the coordinator may spawn as session threads. 1–20 entries. Each entry is an agent ID string, a versioned `{"type":"agent","id","version"}` reference, or `{"type":"self"}` to allow recursive self-invocation. Entries must reference distinct agents (after resolving `self` and string forms); at most one `self`. Referenced agents must exist, must not be archived, and must not themselves have `multiagent` set (depth limit 1). - `string` - `type BetaManagedAgentsAgentParamsResp struct{…}` Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version - `ID string` The `agent` ID. - `Type BetaManagedAgentsAgentParamsType` - `const BetaManagedAgentsAgentParamsTypeAgent BetaManagedAgentsAgentParamsType = "agent"` - `Version int64` The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified. - `type BetaManagedAgentsMultiagentSelfParamsResp struct{…}` Sentinel roster entry meaning "the agent that owns this configuration". Resolved server-side to a concrete agent reference. - `Type BetaManagedAgentsMultiagentSelfParamsType` - `const BetaManagedAgentsMultiagentSelfParamsTypeSelf BetaManagedAgentsMultiagentSelfParamsType = "self"` - `Type BetaManagedAgentsMultiagentCoordinatorParamsType` - `const BetaManagedAgentsMultiagentCoordinatorParamsTypeCoordinator BetaManagedAgentsMultiagentCoordinatorParamsType = "coordinator"` ### Beta Managed Agents Multiagent Self Params - `type BetaManagedAgentsMultiagentSelfParamsResp struct{…}` Sentinel roster entry meaning "the agent that owns this configuration". Resolved server-side to a concrete agent reference. - `Type BetaManagedAgentsMultiagentSelfParamsType` - `const BetaManagedAgentsMultiagentSelfParamsTypeSelf BetaManagedAgentsMultiagentSelfParamsType = "self"` ### Beta Managed Agents Session Thread Agent - `type BetaManagedAgentsSessionThreadAgent struct{…}` Resolved `agent` definition for a single `session_thread`. Snapshot of the agent at thread creation time. The multiagent roster is not repeated here; read it from `Session.agent`. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Name string` - `Skills []BetaManagedAgentsSessionThreadAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsSessionThreadAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsSessionThreadAgentType` - `const BetaManagedAgentsSessionThreadAgentTypeAgent BetaManagedAgentsSessionThreadAgentType = "agent"` - `Version int64` ### Beta Managed Agents Skill Params - `type BetaManagedAgentsSkillParamsUnionResp interface{…}` Skill to load in the session container. - `type BetaManagedAgentsAnthropicSkillParamsResp struct{…}` An Anthropic-managed skill. - `SkillID string` Identifier of the Anthropic skill (e.g., "xlsx"). - `Type BetaManagedAgentsAnthropicSkillParamsType` - `const BetaManagedAgentsAnthropicSkillParamsTypeAnthropic BetaManagedAgentsAnthropicSkillParamsType = "anthropic"` - `Version string` Version to pin. Defaults to latest if omitted. - `type BetaManagedAgentsCustomSkillParamsResp struct{…}` A user-created custom skill. - `SkillID string` Tagged ID of the custom skill (e.g., "skill_01XJ5..."). - `Type BetaManagedAgentsCustomSkillParamsType` - `const BetaManagedAgentsCustomSkillParamsTypeCustom BetaManagedAgentsCustomSkillParamsType = "custom"` - `Version string` Version to pin. Defaults to latest if omitted. ### Beta Managed Agents URL MCP Server Params - `type BetaManagedAgentsURLMCPServerParamsResp struct{…}` URL-based MCP server connection. - `Name string` Unique name for this server, referenced by mcp_toolset configurations. 1-255 characters. - `Type BetaManagedAgentsURLMCPServerParamsType` - `const BetaManagedAgentsURLMCPServerParamsTypeURL BetaManagedAgentsURLMCPServerParamsType = "url"` - `URL string` Endpoint URL for the MCP server. # Versions ## List Agent Versions `client.Beta.Agents.Versions.List(ctx, agentID, params) (*PageCursor[BetaManagedAgentsAgent], error)` **get** `/v1/agents/{agent_id}/versions` List Agent Versions ### Parameters - `agentID string` - `params BetaAgentVersionListParams` - `Limit param.Field[int64]` Query param: Maximum results per page. Default 20, maximum 100. - `Page param.Field[string]` Query param: Opaque pagination cursor. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsAgent struct{…}` A Managed Agents `agent`. - `ID string` - `ArchivedAt Time` A timestamp in RFC 3339 format - `CreatedAt Time` A timestamp in RFC 3339 format - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Metadata map[string, string]` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Multiagent BetaManagedAgentsMultiagent` Resolved coordinator topology with a concrete agent roster. - `Agents []BetaManagedAgentsAgentReference` Agents the coordinator may spawn as session threads, each resolved to a specific version. - `ID string` - `Type BetaManagedAgentsAgentReferenceType` - `const BetaManagedAgentsAgentReferenceTypeAgent BetaManagedAgentsAgentReferenceType = "agent"` - `Version int64` - `Type BetaManagedAgentsMultiagentType` - `const BetaManagedAgentsMultiagentTypeCoordinator BetaManagedAgentsMultiagentType = "coordinator"` - `Name string` - `Skills []BetaManagedAgentsAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsAgentType` - `const BetaManagedAgentsAgentTypeAgent BetaManagedAgentsAgentType = "agent"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `Version int64` The agent's current version. Starts at 1 and increments when the agent is modified. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) page, err := client.Beta.Agents.Versions.List( context.TODO(), "agent_011CZkYpogX7uDKUyvBTophP", anthropic.BetaAgentVersionListParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "data": [ { "id": "agent_011CZkYpogX7uDKUyvBTophP", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "metadata": { "foo": "bar" }, "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "updated_at": "2026-03-15T10:00:00Z", "version": 1 } ], "next_page": "next_page" } ``` # Environments ## Create Environment `client.Beta.Environments.New(ctx, params) (*BetaEnvironment, error)` **post** `/v1/environments` Create a new environment with the specified configuration. ### Parameters - `params BetaEnvironmentNewParams` - `Name param.Field[string]` Body param: Human-readable name for the environment - `Config param.Field[BetaEnvironmentNewParamsConfigUnion]` Body param: Environment configuration - `type BetaCloudConfigParamsResp struct{…}` Request params for `cloud` environment configuration. Fields default to null; on update, omitted fields preserve the existing value. - `Type Cloud` Environment type - `const CloudCloud Cloud = "cloud"` - `Networking BetaCloudConfigParamsNetworkingUnionResp` Network configuration policy. Omit on update to preserve the existing value. - `type BetaUnrestrictedNetwork struct{…}` Unrestricted network access. - `Type Unrestricted` Network policy type - `const UnrestrictedUnrestricted Unrestricted = "unrestricted"` - `type BetaLimitedNetworkParamsResp struct{…}` Limited network request params. Fields default to null; on update, omitted fields preserve the existing value. - `Type Limited` Network policy type - `const LimitedLimited Limited = "limited"` - `AllowMCPServers bool` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. Defaults to `false`. - `AllowPackageManagers bool` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. - `AllowedHosts []string` Specifies domains the container can reach. - `Packages BetaPackagesParamsResp` Specify packages (and optionally their versions) available in this environment. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. - `Apt []string` Ubuntu/Debian packages to install - `Cargo []string` Rust packages to install - `Gem []string` Ruby packages to install - `Go []string` Go packages to install - `Npm []string` Node.js packages to install - `Pip []string` Python packages to install - `Type BetaPackagesParamsType` Package configuration type - `const BetaPackagesParamsTypePackages BetaPackagesParamsType = "packages"` - `type BetaSelfHostedConfigParamsResp struct{…}` Request params for `self_hosted` environment configuration. - `Type SelfHosted` Environment type - `const SelfHostedSelfHosted SelfHosted = "self_hosted"` - `Description param.Field[string]` Body param: Optional description of the environment - `Metadata param.Field[map[string, string]]` Body param: User-provided metadata key-value pairs - `Scope param.Field[BetaEnvironmentNewParamsScope]` Body param: The visibility scope for this environment. 'organization' makes the environment visible to all accounts. 'account' restricts visibility to the owning account only. Only applicable for self-hosted environments. If not specified, defaults based on organization type. - `const BetaEnvironmentNewParamsScopeOrganization BetaEnvironmentNewParamsScope = "organization"` - `const BetaEnvironmentNewParamsScopeAccount BetaEnvironmentNewParamsScope = "account"` - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaEnvironment struct{…}` Unified Environment resource for both cloud and self-hosted environments. - `ID string` Environment identifier (e.g., 'env_...') - `ArchivedAt string` RFC 3339 timestamp when environment was archived, or null if not archived - `Config BetaEnvironmentConfigUnion` Environment configuration (either Anthropic Cloud or self-hosted) - `type BetaCloudConfig struct{…}` `cloud` environment configuration. - `Networking BetaCloudConfigNetworkingUnion` Network configuration policy. - `type BetaUnrestrictedNetwork struct{…}` Unrestricted network access. - `Type Unrestricted` Network policy type - `const UnrestrictedUnrestricted Unrestricted = "unrestricted"` - `type BetaLimitedNetwork struct{…}` Limited network access. - `AllowMCPServers bool` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `AllowPackageManagers bool` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `AllowedHosts []string` Specifies domains the container can reach. - `Type Limited` Network policy type - `const LimitedLimited Limited = "limited"` - `Packages BetaPackages` Package manager configuration. - `Apt []string` Ubuntu/Debian packages to install - `Cargo []string` Rust packages to install - `Gem []string` Ruby packages to install - `Go []string` Go packages to install - `Npm []string` Node.js packages to install - `Pip []string` Python packages to install - `Type BetaPackagesType` Package configuration type - `const BetaPackagesTypePackages BetaPackagesType = "packages"` - `Type Cloud` Environment type - `const CloudCloud Cloud = "cloud"` - `type BetaSelfHostedConfig struct{…}` Configuration for self-hosted environments. - `Type SelfHosted` Environment type - `const SelfHostedSelfHosted SelfHosted = "self_hosted"` - `CreatedAt string` RFC 3339 timestamp when environment was created - `Description string` User-provided description for the environment - `Metadata map[string, string]` User-provided metadata key-value pairs - `Name string` Human-readable name for the environment - `Type Environment` The type of object (always 'environment') - `const EnvironmentEnvironment Environment = "environment"` - `UpdatedAt string` RFC 3339 timestamp when environment was last updated - `Scope BetaEnvironmentScope` The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account. - `const BetaEnvironmentScopeOrganization BetaEnvironmentScope = "organization"` - `const BetaEnvironmentScopeAccount BetaEnvironmentScope = "account"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaEnvironment, err := client.Beta.Environments.New(context.TODO(), anthropic.BetaEnvironmentNewParams{ Name: "python-data-analysis", }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaEnvironment.ID) } ``` #### Response ```json { "id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "archived_at": null, "config": { "networking": { "allow_mcp_servers": false, "allow_package_managers": true, "allowed_hosts": [ "api.example.com" ], "type": "limited" }, "packages": { "apt": [ "string" ], "cargo": [ "string" ], "gem": [ "string" ], "go": [ "string" ], "npm": [ "string" ], "pip": [ "pandas", "numpy" ], "type": "packages" }, "type": "cloud" }, "created_at": "2026-03-15T10:00:00Z", "description": "Python environment with data-analysis packages.", "metadata": {}, "name": "python-data-analysis", "type": "environment", "updated_at": "2026-03-15T10:00:00Z", "scope": "organization" } ``` ## List Environments `client.Beta.Environments.List(ctx, params) (*PageCursor[BetaEnvironment], error)` **get** `/v1/environments` List environments with pagination support. ### Parameters - `params BetaEnvironmentListParams` - `IncludeArchived param.Field[bool]` Query param: Include archived environments in the response - `Limit param.Field[int64]` Query param: Maximum number of environments to return - `Page param.Field[string]` Query param: Opaque cursor from previous response for pagination. Pass the `next_page` value from the previous response. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaEnvironment struct{…}` Unified Environment resource for both cloud and self-hosted environments. - `ID string` Environment identifier (e.g., 'env_...') - `ArchivedAt string` RFC 3339 timestamp when environment was archived, or null if not archived - `Config BetaEnvironmentConfigUnion` Environment configuration (either Anthropic Cloud or self-hosted) - `type BetaCloudConfig struct{…}` `cloud` environment configuration. - `Networking BetaCloudConfigNetworkingUnion` Network configuration policy. - `type BetaUnrestrictedNetwork struct{…}` Unrestricted network access. - `Type Unrestricted` Network policy type - `const UnrestrictedUnrestricted Unrestricted = "unrestricted"` - `type BetaLimitedNetwork struct{…}` Limited network access. - `AllowMCPServers bool` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `AllowPackageManagers bool` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `AllowedHosts []string` Specifies domains the container can reach. - `Type Limited` Network policy type - `const LimitedLimited Limited = "limited"` - `Packages BetaPackages` Package manager configuration. - `Apt []string` Ubuntu/Debian packages to install - `Cargo []string` Rust packages to install - `Gem []string` Ruby packages to install - `Go []string` Go packages to install - `Npm []string` Node.js packages to install - `Pip []string` Python packages to install - `Type BetaPackagesType` Package configuration type - `const BetaPackagesTypePackages BetaPackagesType = "packages"` - `Type Cloud` Environment type - `const CloudCloud Cloud = "cloud"` - `type BetaSelfHostedConfig struct{…}` Configuration for self-hosted environments. - `Type SelfHosted` Environment type - `const SelfHostedSelfHosted SelfHosted = "self_hosted"` - `CreatedAt string` RFC 3339 timestamp when environment was created - `Description string` User-provided description for the environment - `Metadata map[string, string]` User-provided metadata key-value pairs - `Name string` Human-readable name for the environment - `Type Environment` The type of object (always 'environment') - `const EnvironmentEnvironment Environment = "environment"` - `UpdatedAt string` RFC 3339 timestamp when environment was last updated - `Scope BetaEnvironmentScope` The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account. - `const BetaEnvironmentScopeOrganization BetaEnvironmentScope = "organization"` - `const BetaEnvironmentScopeAccount BetaEnvironmentScope = "account"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) page, err := client.Beta.Environments.List(context.TODO(), anthropic.BetaEnvironmentListParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "data": [ { "id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "archived_at": null, "config": { "networking": { "allow_mcp_servers": false, "allow_package_managers": true, "allowed_hosts": [ "api.example.com" ], "type": "limited" }, "packages": { "apt": [ "string" ], "cargo": [ "string" ], "gem": [ "string" ], "go": [ "string" ], "npm": [ "string" ], "pip": [ "pandas", "numpy" ], "type": "packages" }, "type": "cloud" }, "created_at": "2026-03-15T10:00:00Z", "description": "Python environment with data-analysis packages.", "metadata": {}, "name": "python-data-analysis", "type": "environment", "updated_at": "2026-03-15T10:00:00Z", "scope": "organization" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ## Get Environment `client.Beta.Environments.Get(ctx, environmentID, query) (*BetaEnvironment, error)` **get** `/v1/environments/{environment_id}` Retrieve a specific environment by ID. ### Parameters - `environmentID string` - `query BetaEnvironmentGetParams` - `Betas param.Field[[]AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaEnvironment struct{…}` Unified Environment resource for both cloud and self-hosted environments. - `ID string` Environment identifier (e.g., 'env_...') - `ArchivedAt string` RFC 3339 timestamp when environment was archived, or null if not archived - `Config BetaEnvironmentConfigUnion` Environment configuration (either Anthropic Cloud or self-hosted) - `type BetaCloudConfig struct{…}` `cloud` environment configuration. - `Networking BetaCloudConfigNetworkingUnion` Network configuration policy. - `type BetaUnrestrictedNetwork struct{…}` Unrestricted network access. - `Type Unrestricted` Network policy type - `const UnrestrictedUnrestricted Unrestricted = "unrestricted"` - `type BetaLimitedNetwork struct{…}` Limited network access. - `AllowMCPServers bool` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `AllowPackageManagers bool` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `AllowedHosts []string` Specifies domains the container can reach. - `Type Limited` Network policy type - `const LimitedLimited Limited = "limited"` - `Packages BetaPackages` Package manager configuration. - `Apt []string` Ubuntu/Debian packages to install - `Cargo []string` Rust packages to install - `Gem []string` Ruby packages to install - `Go []string` Go packages to install - `Npm []string` Node.js packages to install - `Pip []string` Python packages to install - `Type BetaPackagesType` Package configuration type - `const BetaPackagesTypePackages BetaPackagesType = "packages"` - `Type Cloud` Environment type - `const CloudCloud Cloud = "cloud"` - `type BetaSelfHostedConfig struct{…}` Configuration for self-hosted environments. - `Type SelfHosted` Environment type - `const SelfHostedSelfHosted SelfHosted = "self_hosted"` - `CreatedAt string` RFC 3339 timestamp when environment was created - `Description string` User-provided description for the environment - `Metadata map[string, string]` User-provided metadata key-value pairs - `Name string` Human-readable name for the environment - `Type Environment` The type of object (always 'environment') - `const EnvironmentEnvironment Environment = "environment"` - `UpdatedAt string` RFC 3339 timestamp when environment was last updated - `Scope BetaEnvironmentScope` The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account. - `const BetaEnvironmentScopeOrganization BetaEnvironmentScope = "organization"` - `const BetaEnvironmentScopeAccount BetaEnvironmentScope = "account"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaEnvironment, err := client.Beta.Environments.Get( context.TODO(), "env_011CZkZ9X2dpNyB7HsEFoRfW", anthropic.BetaEnvironmentGetParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaEnvironment.ID) } ``` #### Response ```json { "id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "archived_at": null, "config": { "networking": { "allow_mcp_servers": false, "allow_package_managers": true, "allowed_hosts": [ "api.example.com" ], "type": "limited" }, "packages": { "apt": [ "string" ], "cargo": [ "string" ], "gem": [ "string" ], "go": [ "string" ], "npm": [ "string" ], "pip": [ "pandas", "numpy" ], "type": "packages" }, "type": "cloud" }, "created_at": "2026-03-15T10:00:00Z", "description": "Python environment with data-analysis packages.", "metadata": {}, "name": "python-data-analysis", "type": "environment", "updated_at": "2026-03-15T10:00:00Z", "scope": "organization" } ``` ## Update Environment `client.Beta.Environments.Update(ctx, environmentID, params) (*BetaEnvironment, error)` **post** `/v1/environments/{environment_id}` Update an existing environment's configuration. ### Parameters - `environmentID string` - `params BetaEnvironmentUpdateParams` - `Config param.Field[BetaEnvironmentUpdateParamsConfigUnion]` Body param: Updated environment configuration - `type BetaCloudConfigParamsResp struct{…}` Request params for `cloud` environment configuration. Fields default to null; on update, omitted fields preserve the existing value. - `Type Cloud` Environment type - `const CloudCloud Cloud = "cloud"` - `Networking BetaCloudConfigParamsNetworkingUnionResp` Network configuration policy. Omit on update to preserve the existing value. - `type BetaUnrestrictedNetwork struct{…}` Unrestricted network access. - `Type Unrestricted` Network policy type - `const UnrestrictedUnrestricted Unrestricted = "unrestricted"` - `type BetaLimitedNetworkParamsResp struct{…}` Limited network request params. Fields default to null; on update, omitted fields preserve the existing value. - `Type Limited` Network policy type - `const LimitedLimited Limited = "limited"` - `AllowMCPServers bool` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. Defaults to `false`. - `AllowPackageManagers bool` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. - `AllowedHosts []string` Specifies domains the container can reach. - `Packages BetaPackagesParamsResp` Specify packages (and optionally their versions) available in this environment. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. - `Apt []string` Ubuntu/Debian packages to install - `Cargo []string` Rust packages to install - `Gem []string` Ruby packages to install - `Go []string` Go packages to install - `Npm []string` Node.js packages to install - `Pip []string` Python packages to install - `Type BetaPackagesParamsType` Package configuration type - `const BetaPackagesParamsTypePackages BetaPackagesParamsType = "packages"` - `type BetaSelfHostedConfigParamsResp struct{…}` Request params for `self_hosted` environment configuration. - `Type SelfHosted` Environment type - `const SelfHostedSelfHosted SelfHosted = "self_hosted"` - `Description param.Field[string]` Body param: Updated description of the environment - `Metadata param.Field[map[string, string]]` Body param: User-provided metadata key-value pairs. Set a value to null or empty string to delete the key. - `Name param.Field[string]` Body param: Updated name for the environment - `Scope param.Field[BetaEnvironmentUpdateParamsScope]` Body param: The visibility scope for this environment. 'organization' makes the environment visible to all accounts. 'account' restricts visibility to the owning account only. - `const BetaEnvironmentUpdateParamsScopeOrganization BetaEnvironmentUpdateParamsScope = "organization"` - `const BetaEnvironmentUpdateParamsScopeAccount BetaEnvironmentUpdateParamsScope = "account"` - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaEnvironment struct{…}` Unified Environment resource for both cloud and self-hosted environments. - `ID string` Environment identifier (e.g., 'env_...') - `ArchivedAt string` RFC 3339 timestamp when environment was archived, or null if not archived - `Config BetaEnvironmentConfigUnion` Environment configuration (either Anthropic Cloud or self-hosted) - `type BetaCloudConfig struct{…}` `cloud` environment configuration. - `Networking BetaCloudConfigNetworkingUnion` Network configuration policy. - `type BetaUnrestrictedNetwork struct{…}` Unrestricted network access. - `Type Unrestricted` Network policy type - `const UnrestrictedUnrestricted Unrestricted = "unrestricted"` - `type BetaLimitedNetwork struct{…}` Limited network access. - `AllowMCPServers bool` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `AllowPackageManagers bool` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `AllowedHosts []string` Specifies domains the container can reach. - `Type Limited` Network policy type - `const LimitedLimited Limited = "limited"` - `Packages BetaPackages` Package manager configuration. - `Apt []string` Ubuntu/Debian packages to install - `Cargo []string` Rust packages to install - `Gem []string` Ruby packages to install - `Go []string` Go packages to install - `Npm []string` Node.js packages to install - `Pip []string` Python packages to install - `Type BetaPackagesType` Package configuration type - `const BetaPackagesTypePackages BetaPackagesType = "packages"` - `Type Cloud` Environment type - `const CloudCloud Cloud = "cloud"` - `type BetaSelfHostedConfig struct{…}` Configuration for self-hosted environments. - `Type SelfHosted` Environment type - `const SelfHostedSelfHosted SelfHosted = "self_hosted"` - `CreatedAt string` RFC 3339 timestamp when environment was created - `Description string` User-provided description for the environment - `Metadata map[string, string]` User-provided metadata key-value pairs - `Name string` Human-readable name for the environment - `Type Environment` The type of object (always 'environment') - `const EnvironmentEnvironment Environment = "environment"` - `UpdatedAt string` RFC 3339 timestamp when environment was last updated - `Scope BetaEnvironmentScope` The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account. - `const BetaEnvironmentScopeOrganization BetaEnvironmentScope = "organization"` - `const BetaEnvironmentScopeAccount BetaEnvironmentScope = "account"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaEnvironment, err := client.Beta.Environments.Update( context.TODO(), "env_011CZkZ9X2dpNyB7HsEFoRfW", anthropic.BetaEnvironmentUpdateParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaEnvironment.ID) } ``` #### Response ```json { "id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "archived_at": null, "config": { "networking": { "allow_mcp_servers": false, "allow_package_managers": true, "allowed_hosts": [ "api.example.com" ], "type": "limited" }, "packages": { "apt": [ "string" ], "cargo": [ "string" ], "gem": [ "string" ], "go": [ "string" ], "npm": [ "string" ], "pip": [ "pandas", "numpy" ], "type": "packages" }, "type": "cloud" }, "created_at": "2026-03-15T10:00:00Z", "description": "Python environment with data-analysis packages.", "metadata": {}, "name": "python-data-analysis", "type": "environment", "updated_at": "2026-03-15T10:00:00Z", "scope": "organization" } ``` ## Delete Environment `client.Beta.Environments.Delete(ctx, environmentID, body) (*BetaEnvironmentDeleteResponse, error)` **delete** `/v1/environments/{environment_id}` Delete an environment by ID. Returns a confirmation of the deletion. ### Parameters - `environmentID string` - `body BetaEnvironmentDeleteParams` - `Betas param.Field[[]AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaEnvironmentDeleteResponse struct{…}` Response after deleting an environment. - `ID string` Environment identifier - `Type EnvironmentDeleted` The type of response - `const EnvironmentDeletedEnvironmentDeleted EnvironmentDeleted = "environment_deleted"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaEnvironmentDeleteResponse, err := client.Beta.Environments.Delete( context.TODO(), "env_011CZkZ9X2dpNyB7HsEFoRfW", anthropic.BetaEnvironmentDeleteParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaEnvironmentDeleteResponse.ID) } ``` #### Response ```json { "id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "type": "environment_deleted" } ``` ## Archive Environment `client.Beta.Environments.Archive(ctx, environmentID, body) (*BetaEnvironment, error)` **post** `/v1/environments/{environment_id}/archive` Archive an environment by ID. Archived environments cannot be used to create new sessions. ### Parameters - `environmentID string` - `body BetaEnvironmentArchiveParams` - `Betas param.Field[[]AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaEnvironment struct{…}` Unified Environment resource for both cloud and self-hosted environments. - `ID string` Environment identifier (e.g., 'env_...') - `ArchivedAt string` RFC 3339 timestamp when environment was archived, or null if not archived - `Config BetaEnvironmentConfigUnion` Environment configuration (either Anthropic Cloud or self-hosted) - `type BetaCloudConfig struct{…}` `cloud` environment configuration. - `Networking BetaCloudConfigNetworkingUnion` Network configuration policy. - `type BetaUnrestrictedNetwork struct{…}` Unrestricted network access. - `Type Unrestricted` Network policy type - `const UnrestrictedUnrestricted Unrestricted = "unrestricted"` - `type BetaLimitedNetwork struct{…}` Limited network access. - `AllowMCPServers bool` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `AllowPackageManagers bool` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `AllowedHosts []string` Specifies domains the container can reach. - `Type Limited` Network policy type - `const LimitedLimited Limited = "limited"` - `Packages BetaPackages` Package manager configuration. - `Apt []string` Ubuntu/Debian packages to install - `Cargo []string` Rust packages to install - `Gem []string` Ruby packages to install - `Go []string` Go packages to install - `Npm []string` Node.js packages to install - `Pip []string` Python packages to install - `Type BetaPackagesType` Package configuration type - `const BetaPackagesTypePackages BetaPackagesType = "packages"` - `Type Cloud` Environment type - `const CloudCloud Cloud = "cloud"` - `type BetaSelfHostedConfig struct{…}` Configuration for self-hosted environments. - `Type SelfHosted` Environment type - `const SelfHostedSelfHosted SelfHosted = "self_hosted"` - `CreatedAt string` RFC 3339 timestamp when environment was created - `Description string` User-provided description for the environment - `Metadata map[string, string]` User-provided metadata key-value pairs - `Name string` Human-readable name for the environment - `Type Environment` The type of object (always 'environment') - `const EnvironmentEnvironment Environment = "environment"` - `UpdatedAt string` RFC 3339 timestamp when environment was last updated - `Scope BetaEnvironmentScope` The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account. - `const BetaEnvironmentScopeOrganization BetaEnvironmentScope = "organization"` - `const BetaEnvironmentScopeAccount BetaEnvironmentScope = "account"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaEnvironment, err := client.Beta.Environments.Archive( context.TODO(), "env_011CZkZ9X2dpNyB7HsEFoRfW", anthropic.BetaEnvironmentArchiveParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaEnvironment.ID) } ``` #### Response ```json { "id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "archived_at": null, "config": { "networking": { "allow_mcp_servers": false, "allow_package_managers": true, "allowed_hosts": [ "api.example.com" ], "type": "limited" }, "packages": { "apt": [ "string" ], "cargo": [ "string" ], "gem": [ "string" ], "go": [ "string" ], "npm": [ "string" ], "pip": [ "pandas", "numpy" ], "type": "packages" }, "type": "cloud" }, "created_at": "2026-03-15T10:00:00Z", "description": "Python environment with data-analysis packages.", "metadata": {}, "name": "python-data-analysis", "type": "environment", "updated_at": "2026-03-15T10:00:00Z", "scope": "organization" } ``` ## Domain Types ### Beta Cloud Config - `type BetaCloudConfig struct{…}` `cloud` environment configuration. - `Networking BetaCloudConfigNetworkingUnion` Network configuration policy. - `type BetaUnrestrictedNetwork struct{…}` Unrestricted network access. - `Type Unrestricted` Network policy type - `const UnrestrictedUnrestricted Unrestricted = "unrestricted"` - `type BetaLimitedNetwork struct{…}` Limited network access. - `AllowMCPServers bool` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `AllowPackageManagers bool` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `AllowedHosts []string` Specifies domains the container can reach. - `Type Limited` Network policy type - `const LimitedLimited Limited = "limited"` - `Packages BetaPackages` Package manager configuration. - `Apt []string` Ubuntu/Debian packages to install - `Cargo []string` Rust packages to install - `Gem []string` Ruby packages to install - `Go []string` Go packages to install - `Npm []string` Node.js packages to install - `Pip []string` Python packages to install - `Type BetaPackagesType` Package configuration type - `const BetaPackagesTypePackages BetaPackagesType = "packages"` - `Type Cloud` Environment type - `const CloudCloud Cloud = "cloud"` ### Beta Cloud Config Params - `type BetaCloudConfigParamsResp struct{…}` Request params for `cloud` environment configuration. Fields default to null; on update, omitted fields preserve the existing value. - `Type Cloud` Environment type - `const CloudCloud Cloud = "cloud"` - `Networking BetaCloudConfigParamsNetworkingUnionResp` Network configuration policy. Omit on update to preserve the existing value. - `type BetaUnrestrictedNetwork struct{…}` Unrestricted network access. - `Type Unrestricted` Network policy type - `const UnrestrictedUnrestricted Unrestricted = "unrestricted"` - `type BetaLimitedNetworkParamsResp struct{…}` Limited network request params. Fields default to null; on update, omitted fields preserve the existing value. - `Type Limited` Network policy type - `const LimitedLimited Limited = "limited"` - `AllowMCPServers bool` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. Defaults to `false`. - `AllowPackageManagers bool` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. - `AllowedHosts []string` Specifies domains the container can reach. - `Packages BetaPackagesParamsResp` Specify packages (and optionally their versions) available in this environment. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. - `Apt []string` Ubuntu/Debian packages to install - `Cargo []string` Rust packages to install - `Gem []string` Ruby packages to install - `Go []string` Go packages to install - `Npm []string` Node.js packages to install - `Pip []string` Python packages to install - `Type BetaPackagesParamsType` Package configuration type - `const BetaPackagesParamsTypePackages BetaPackagesParamsType = "packages"` ### Beta Environment - `type BetaEnvironment struct{…}` Unified Environment resource for both cloud and self-hosted environments. - `ID string` Environment identifier (e.g., 'env_...') - `ArchivedAt string` RFC 3339 timestamp when environment was archived, or null if not archived - `Config BetaEnvironmentConfigUnion` Environment configuration (either Anthropic Cloud or self-hosted) - `type BetaCloudConfig struct{…}` `cloud` environment configuration. - `Networking BetaCloudConfigNetworkingUnion` Network configuration policy. - `type BetaUnrestrictedNetwork struct{…}` Unrestricted network access. - `Type Unrestricted` Network policy type - `const UnrestrictedUnrestricted Unrestricted = "unrestricted"` - `type BetaLimitedNetwork struct{…}` Limited network access. - `AllowMCPServers bool` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `AllowPackageManagers bool` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `AllowedHosts []string` Specifies domains the container can reach. - `Type Limited` Network policy type - `const LimitedLimited Limited = "limited"` - `Packages BetaPackages` Package manager configuration. - `Apt []string` Ubuntu/Debian packages to install - `Cargo []string` Rust packages to install - `Gem []string` Ruby packages to install - `Go []string` Go packages to install - `Npm []string` Node.js packages to install - `Pip []string` Python packages to install - `Type BetaPackagesType` Package configuration type - `const BetaPackagesTypePackages BetaPackagesType = "packages"` - `Type Cloud` Environment type - `const CloudCloud Cloud = "cloud"` - `type BetaSelfHostedConfig struct{…}` Configuration for self-hosted environments. - `Type SelfHosted` Environment type - `const SelfHostedSelfHosted SelfHosted = "self_hosted"` - `CreatedAt string` RFC 3339 timestamp when environment was created - `Description string` User-provided description for the environment - `Metadata map[string, string]` User-provided metadata key-value pairs - `Name string` Human-readable name for the environment - `Type Environment` The type of object (always 'environment') - `const EnvironmentEnvironment Environment = "environment"` - `UpdatedAt string` RFC 3339 timestamp when environment was last updated - `Scope BetaEnvironmentScope` The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account. - `const BetaEnvironmentScopeOrganization BetaEnvironmentScope = "organization"` - `const BetaEnvironmentScopeAccount BetaEnvironmentScope = "account"` ### Beta Environment Delete Response - `type BetaEnvironmentDeleteResponse struct{…}` Response after deleting an environment. - `ID string` Environment identifier - `Type EnvironmentDeleted` The type of response - `const EnvironmentDeletedEnvironmentDeleted EnvironmentDeleted = "environment_deleted"` ### Beta Limited Network - `type BetaLimitedNetwork struct{…}` Limited network access. - `AllowMCPServers bool` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `AllowPackageManagers bool` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `AllowedHosts []string` Specifies domains the container can reach. - `Type Limited` Network policy type - `const LimitedLimited Limited = "limited"` ### Beta Limited Network Params - `type BetaLimitedNetworkParamsResp struct{…}` Limited network request params. Fields default to null; on update, omitted fields preserve the existing value. - `Type Limited` Network policy type - `const LimitedLimited Limited = "limited"` - `AllowMCPServers bool` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. Defaults to `false`. - `AllowPackageManagers bool` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. - `AllowedHosts []string` Specifies domains the container can reach. ### Beta Packages - `type BetaPackages struct{…}` Packages (and their versions) available in this environment. - `Apt []string` Ubuntu/Debian packages to install - `Cargo []string` Rust packages to install - `Gem []string` Ruby packages to install - `Go []string` Go packages to install - `Npm []string` Node.js packages to install - `Pip []string` Python packages to install - `Type BetaPackagesType` Package configuration type - `const BetaPackagesTypePackages BetaPackagesType = "packages"` ### Beta Packages Params - `type BetaPackagesParamsResp struct{…}` Specify packages (and optionally their versions) available in this environment. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. - `Apt []string` Ubuntu/Debian packages to install - `Cargo []string` Rust packages to install - `Gem []string` Ruby packages to install - `Go []string` Go packages to install - `Npm []string` Node.js packages to install - `Pip []string` Python packages to install - `Type BetaPackagesParamsType` Package configuration type - `const BetaPackagesParamsTypePackages BetaPackagesParamsType = "packages"` ### Beta Self Hosted Config - `type BetaSelfHostedConfig struct{…}` Configuration for self-hosted environments. - `Type SelfHosted` Environment type - `const SelfHostedSelfHosted SelfHosted = "self_hosted"` ### Beta Self Hosted Config Params - `type BetaSelfHostedConfigParamsResp struct{…}` Request params for `self_hosted` environment configuration. - `Type SelfHosted` Environment type - `const SelfHostedSelfHosted SelfHosted = "self_hosted"` ### Beta Unrestricted Network - `type BetaUnrestrictedNetwork struct{…}` Unrestricted network access. - `Type Unrestricted` Network policy type - `const UnrestrictedUnrestricted Unrestricted = "unrestricted"` # Work ## Get Work Item `client.Beta.Environments.Work.Get(ctx, workID, params) (*BetaSelfHostedWork, error)` **get** `/v1/environments/{environment_id}/work/{work_id}` Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly. Retrieve detailed information about a specific work item. ### Parameters - `workID string` - `params BetaEnvironmentWorkGetParams` - `EnvironmentID param.Field[string]` Path param - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaSelfHostedWork struct{…}` Work resource representing a unit of work in a self-hosted environment. Work items are queued when sessions are created or when long-dormant sessions receive new messages. The environment worker polls for work to execute in a self-hosted sandbox. - `ID string` Work identifier (e.g., 'work_...') - `AcknowledgedAt string` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `CreatedAt string` RFC 3339 timestamp when work was created - `Data BetaSessionWorkData` The actual work to be performed - `ID string` Session identifier (e.g., 'session_...') - `Type Session` Type of work data - `const SessionSession Session = "session"` - `EnvironmentID string` Environment identifier this work belongs to (e.g., `env_...`) - `LatestHeartbeatAt string` RFC 3339 timestamp of the most recent heartbeat - `Metadata map[string, string]` User-provided metadata key-value pairs associated with this work item - `StartedAt string` RFC 3339 timestamp when work execution started - `State BetaSelfHostedWorkState` Current state of the work item - `const BetaSelfHostedWorkStateQueued BetaSelfHostedWorkState = "queued"` - `const BetaSelfHostedWorkStateStarting BetaSelfHostedWorkState = "starting"` - `const BetaSelfHostedWorkStateActive BetaSelfHostedWorkState = "active"` - `const BetaSelfHostedWorkStateStopping BetaSelfHostedWorkState = "stopping"` - `const BetaSelfHostedWorkStateStopped BetaSelfHostedWorkState = "stopped"` - `StopRequestedAt string` RFC 3339 timestamp when stop was requested - `StoppedAt string` RFC 3339 timestamp when work execution stopped - `Type Work` The type of object (always 'work') - `const WorkWork Work = "work"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaSelfHostedWork, err := client.Beta.Environments.Work.Get( context.TODO(), "work_id", anthropic.BetaEnvironmentWorkGetParams{ EnvironmentID: "env_011CZkZ9X2dpNyB7HsEFoRfW", }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaSelfHostedWork.ID) } ``` #### Response ```json { "id": "id", "acknowledged_at": "acknowledged_at", "created_at": "created_at", "data": { "id": "id", "type": "session" }, "environment_id": "environment_id", "latest_heartbeat_at": "latest_heartbeat_at", "metadata": { "foo": "string" }, "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ``` ## Poll for Work `client.Beta.Environments.Work.Poll(ctx, environmentID, params) (*BetaSelfHostedWork, error)` **get** `/v1/environments/{environment_id}/work/poll` Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly. Long poll for work items in the queue. ### Parameters - `environmentID string` - `params BetaEnvironmentWorkPollParams` - `BlockMs param.Field[int64]` Query param: How long to wait for work to arrive before returning. Must be 1-999 in milliseconds. Defaults to non-blocking (returns immediately if no work is available). - `ReclaimOlderThanMs param.Field[int64]` Query param: Reclaim unacknowledged work items older than this many milliseconds. If omitted, uses the default (5000ms). - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` - `AnthropicWorkerID param.Field[string]` Header param: Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console ### Returns - `type BetaSelfHostedWork struct{…}` Work resource representing a unit of work in a self-hosted environment. Work items are queued when sessions are created or when long-dormant sessions receive new messages. The environment worker polls for work to execute in a self-hosted sandbox. - `ID string` Work identifier (e.g., 'work_...') - `AcknowledgedAt string` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `CreatedAt string` RFC 3339 timestamp when work was created - `Data BetaSessionWorkData` The actual work to be performed - `ID string` Session identifier (e.g., 'session_...') - `Type Session` Type of work data - `const SessionSession Session = "session"` - `EnvironmentID string` Environment identifier this work belongs to (e.g., `env_...`) - `LatestHeartbeatAt string` RFC 3339 timestamp of the most recent heartbeat - `Metadata map[string, string]` User-provided metadata key-value pairs associated with this work item - `StartedAt string` RFC 3339 timestamp when work execution started - `State BetaSelfHostedWorkState` Current state of the work item - `const BetaSelfHostedWorkStateQueued BetaSelfHostedWorkState = "queued"` - `const BetaSelfHostedWorkStateStarting BetaSelfHostedWorkState = "starting"` - `const BetaSelfHostedWorkStateActive BetaSelfHostedWorkState = "active"` - `const BetaSelfHostedWorkStateStopping BetaSelfHostedWorkState = "stopping"` - `const BetaSelfHostedWorkStateStopped BetaSelfHostedWorkState = "stopped"` - `StopRequestedAt string` RFC 3339 timestamp when stop was requested - `StoppedAt string` RFC 3339 timestamp when work execution stopped - `Type Work` The type of object (always 'work') - `const WorkWork Work = "work"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaSelfHostedWork, err := client.Beta.Environments.Work.Poll( context.TODO(), "env_011CZkZ9X2dpNyB7HsEFoRfW", anthropic.BetaEnvironmentWorkPollParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaSelfHostedWork.ID) } ``` #### Response ```json { "id": "id", "acknowledged_at": "acknowledged_at", "created_at": "created_at", "data": { "id": "id", "type": "session" }, "environment_id": "environment_id", "latest_heartbeat_at": "latest_heartbeat_at", "metadata": { "foo": "string" }, "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ``` ## Acknowledge Work `client.Beta.Environments.Work.Ack(ctx, workID, params) (*BetaSelfHostedWork, error)` **post** `/v1/environments/{environment_id}/work/{work_id}/ack` Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly. Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' and removing it from the queue. ### Parameters - `workID string` - `params BetaEnvironmentWorkAckParams` - `EnvironmentID param.Field[string]` Path param - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaSelfHostedWork struct{…}` Work resource representing a unit of work in a self-hosted environment. Work items are queued when sessions are created or when long-dormant sessions receive new messages. The environment worker polls for work to execute in a self-hosted sandbox. - `ID string` Work identifier (e.g., 'work_...') - `AcknowledgedAt string` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `CreatedAt string` RFC 3339 timestamp when work was created - `Data BetaSessionWorkData` The actual work to be performed - `ID string` Session identifier (e.g., 'session_...') - `Type Session` Type of work data - `const SessionSession Session = "session"` - `EnvironmentID string` Environment identifier this work belongs to (e.g., `env_...`) - `LatestHeartbeatAt string` RFC 3339 timestamp of the most recent heartbeat - `Metadata map[string, string]` User-provided metadata key-value pairs associated with this work item - `StartedAt string` RFC 3339 timestamp when work execution started - `State BetaSelfHostedWorkState` Current state of the work item - `const BetaSelfHostedWorkStateQueued BetaSelfHostedWorkState = "queued"` - `const BetaSelfHostedWorkStateStarting BetaSelfHostedWorkState = "starting"` - `const BetaSelfHostedWorkStateActive BetaSelfHostedWorkState = "active"` - `const BetaSelfHostedWorkStateStopping BetaSelfHostedWorkState = "stopping"` - `const BetaSelfHostedWorkStateStopped BetaSelfHostedWorkState = "stopped"` - `StopRequestedAt string` RFC 3339 timestamp when stop was requested - `StoppedAt string` RFC 3339 timestamp when work execution stopped - `Type Work` The type of object (always 'work') - `const WorkWork Work = "work"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaSelfHostedWork, err := client.Beta.Environments.Work.Ack( context.TODO(), "work_id", anthropic.BetaEnvironmentWorkAckParams{ EnvironmentID: "env_011CZkZ9X2dpNyB7HsEFoRfW", }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaSelfHostedWork.ID) } ``` #### Response ```json { "id": "id", "acknowledged_at": "acknowledged_at", "created_at": "created_at", "data": { "id": "id", "type": "session" }, "environment_id": "environment_id", "latest_heartbeat_at": "latest_heartbeat_at", "metadata": { "foo": "string" }, "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ``` ## Record Heartbeat `client.Beta.Environments.Work.Heartbeat(ctx, workID, params) (*BetaSelfHostedWorkHeartbeatResponse, error)` **post** `/v1/environments/{environment_id}/work/{work_id}/heartbeat` Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly. Record a heartbeat for a work item to maintain the lease. ### Parameters - `workID string` - `params BetaEnvironmentWorkHeartbeatParams` - `EnvironmentID param.Field[string]` Path param - `DesiredTTLSeconds param.Field[int64]` Query param: Desired TTL in seconds - `ExpectedLastHeartbeat param.Field[string]` Query param: Expected last_heartbeat for conditional update (optimistic concurrency). Use literal 'NO_HEARTBEAT' to claim an unclaimed lease (first heartbeat). For subsequent heartbeats, echo the server's previous last_heartbeat value exactly. Returns 412 Precondition Failed if the actual value doesn't match. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaSelfHostedWorkHeartbeatResponse struct{…}` Response after recording a heartbeat for a work item. - `LastHeartbeat string` RFC 3339 timestamp of the actual heartbeat from DB - `LeaseExtended bool` Whether the heartbeat succeeded in extending the lease - `State BetaSelfHostedWorkHeartbeatResponseState` Current state of the work item (active/stopping/stopped) - `const BetaSelfHostedWorkHeartbeatResponseStateQueued BetaSelfHostedWorkHeartbeatResponseState = "queued"` - `const BetaSelfHostedWorkHeartbeatResponseStateStarting BetaSelfHostedWorkHeartbeatResponseState = "starting"` - `const BetaSelfHostedWorkHeartbeatResponseStateActive BetaSelfHostedWorkHeartbeatResponseState = "active"` - `const BetaSelfHostedWorkHeartbeatResponseStateStopping BetaSelfHostedWorkHeartbeatResponseState = "stopping"` - `const BetaSelfHostedWorkHeartbeatResponseStateStopped BetaSelfHostedWorkHeartbeatResponseState = "stopped"` - `TTLSeconds int64` Effective TTL applied to the lease - `Type WorkHeartbeat` The type of response - `const WorkHeartbeatWorkHeartbeat WorkHeartbeat = "work_heartbeat"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaSelfHostedWorkHeartbeatResponse, err := client.Beta.Environments.Work.Heartbeat( context.TODO(), "work_id", anthropic.BetaEnvironmentWorkHeartbeatParams{ EnvironmentID: "env_011CZkZ9X2dpNyB7HsEFoRfW", }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaSelfHostedWorkHeartbeatResponse.LastHeartbeat) } ``` #### Response ```json { "last_heartbeat": "last_heartbeat", "lease_extended": true, "state": "queued", "ttl_seconds": 0, "type": "work_heartbeat" } ``` ## Stop Work `client.Beta.Environments.Work.Stop(ctx, workID, params) (*BetaSelfHostedWork, error)` **post** `/v1/environments/{environment_id}/work/{work_id}/stop` Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly. Stop a work item, initiating graceful or forced shutdown. ### Parameters - `workID string` - `params BetaEnvironmentWorkStopParams` - `EnvironmentID param.Field[string]` Path param - `BetaSelfHostedWorkStopRequest param.Field[BetaSelfHostedWorkStopRequest]` Body param: Request to stop a work item. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaSelfHostedWork struct{…}` Work resource representing a unit of work in a self-hosted environment. Work items are queued when sessions are created or when long-dormant sessions receive new messages. The environment worker polls for work to execute in a self-hosted sandbox. - `ID string` Work identifier (e.g., 'work_...') - `AcknowledgedAt string` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `CreatedAt string` RFC 3339 timestamp when work was created - `Data BetaSessionWorkData` The actual work to be performed - `ID string` Session identifier (e.g., 'session_...') - `Type Session` Type of work data - `const SessionSession Session = "session"` - `EnvironmentID string` Environment identifier this work belongs to (e.g., `env_...`) - `LatestHeartbeatAt string` RFC 3339 timestamp of the most recent heartbeat - `Metadata map[string, string]` User-provided metadata key-value pairs associated with this work item - `StartedAt string` RFC 3339 timestamp when work execution started - `State BetaSelfHostedWorkState` Current state of the work item - `const BetaSelfHostedWorkStateQueued BetaSelfHostedWorkState = "queued"` - `const BetaSelfHostedWorkStateStarting BetaSelfHostedWorkState = "starting"` - `const BetaSelfHostedWorkStateActive BetaSelfHostedWorkState = "active"` - `const BetaSelfHostedWorkStateStopping BetaSelfHostedWorkState = "stopping"` - `const BetaSelfHostedWorkStateStopped BetaSelfHostedWorkState = "stopped"` - `StopRequestedAt string` RFC 3339 timestamp when stop was requested - `StoppedAt string` RFC 3339 timestamp when work execution stopped - `Type Work` The type of object (always 'work') - `const WorkWork Work = "work"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaSelfHostedWork, err := client.Beta.Environments.Work.Stop( context.TODO(), "work_id", anthropic.BetaEnvironmentWorkStopParams{ EnvironmentID: "env_011CZkZ9X2dpNyB7HsEFoRfW", BetaSelfHostedWorkStopRequest: anthropic.BetaSelfHostedWorkStopRequestParam{ }, }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaSelfHostedWork.ID) } ``` #### Response ```json { "id": "id", "acknowledged_at": "acknowledged_at", "created_at": "created_at", "data": { "id": "id", "type": "session" }, "environment_id": "environment_id", "latest_heartbeat_at": "latest_heartbeat_at", "metadata": { "foo": "string" }, "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ``` ## List Work Items `client.Beta.Environments.Work.List(ctx, environmentID, params) (*PageCursor[BetaSelfHostedWork], error)` **get** `/v1/environments/{environment_id}/work` Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly. List work items in an environment. ### Parameters - `environmentID string` - `params BetaEnvironmentWorkListParams` - `Limit param.Field[int64]` Query param: Maximum number of work items to return - `Page param.Field[string]` Query param: Opaque cursor from previous response for pagination - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaSelfHostedWork struct{…}` Work resource representing a unit of work in a self-hosted environment. Work items are queued when sessions are created or when long-dormant sessions receive new messages. The environment worker polls for work to execute in a self-hosted sandbox. - `ID string` Work identifier (e.g., 'work_...') - `AcknowledgedAt string` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `CreatedAt string` RFC 3339 timestamp when work was created - `Data BetaSessionWorkData` The actual work to be performed - `ID string` Session identifier (e.g., 'session_...') - `Type Session` Type of work data - `const SessionSession Session = "session"` - `EnvironmentID string` Environment identifier this work belongs to (e.g., `env_...`) - `LatestHeartbeatAt string` RFC 3339 timestamp of the most recent heartbeat - `Metadata map[string, string]` User-provided metadata key-value pairs associated with this work item - `StartedAt string` RFC 3339 timestamp when work execution started - `State BetaSelfHostedWorkState` Current state of the work item - `const BetaSelfHostedWorkStateQueued BetaSelfHostedWorkState = "queued"` - `const BetaSelfHostedWorkStateStarting BetaSelfHostedWorkState = "starting"` - `const BetaSelfHostedWorkStateActive BetaSelfHostedWorkState = "active"` - `const BetaSelfHostedWorkStateStopping BetaSelfHostedWorkState = "stopping"` - `const BetaSelfHostedWorkStateStopped BetaSelfHostedWorkState = "stopped"` - `StopRequestedAt string` RFC 3339 timestamp when stop was requested - `StoppedAt string` RFC 3339 timestamp when work execution stopped - `Type Work` The type of object (always 'work') - `const WorkWork Work = "work"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) page, err := client.Beta.Environments.Work.List( context.TODO(), "env_011CZkZ9X2dpNyB7HsEFoRfW", anthropic.BetaEnvironmentWorkListParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "data": [ { "id": "id", "acknowledged_at": "acknowledged_at", "created_at": "created_at", "data": { "id": "id", "type": "session" }, "environment_id": "environment_id", "latest_heartbeat_at": "latest_heartbeat_at", "metadata": { "foo": "string" }, "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ], "next_page": "next_page" } ``` ## Update Work Item `client.Beta.Environments.Work.Update(ctx, workID, params) (*BetaSelfHostedWork, error)` **post** `/v1/environments/{environment_id}/work/{work_id}` Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly. Update work item metadata with merge semantics. ### Parameters - `workID string` - `params BetaEnvironmentWorkUpdateParams` - `EnvironmentID param.Field[string]` Path param - `BetaSelfHostedWorkUpdateRequest param.Field[BetaSelfHostedWorkUpdateRequest]` Body param: Request to update work item metadata. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaSelfHostedWork struct{…}` Work resource representing a unit of work in a self-hosted environment. Work items are queued when sessions are created or when long-dormant sessions receive new messages. The environment worker polls for work to execute in a self-hosted sandbox. - `ID string` Work identifier (e.g., 'work_...') - `AcknowledgedAt string` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `CreatedAt string` RFC 3339 timestamp when work was created - `Data BetaSessionWorkData` The actual work to be performed - `ID string` Session identifier (e.g., 'session_...') - `Type Session` Type of work data - `const SessionSession Session = "session"` - `EnvironmentID string` Environment identifier this work belongs to (e.g., `env_...`) - `LatestHeartbeatAt string` RFC 3339 timestamp of the most recent heartbeat - `Metadata map[string, string]` User-provided metadata key-value pairs associated with this work item - `StartedAt string` RFC 3339 timestamp when work execution started - `State BetaSelfHostedWorkState` Current state of the work item - `const BetaSelfHostedWorkStateQueued BetaSelfHostedWorkState = "queued"` - `const BetaSelfHostedWorkStateStarting BetaSelfHostedWorkState = "starting"` - `const BetaSelfHostedWorkStateActive BetaSelfHostedWorkState = "active"` - `const BetaSelfHostedWorkStateStopping BetaSelfHostedWorkState = "stopping"` - `const BetaSelfHostedWorkStateStopped BetaSelfHostedWorkState = "stopped"` - `StopRequestedAt string` RFC 3339 timestamp when stop was requested - `StoppedAt string` RFC 3339 timestamp when work execution stopped - `Type Work` The type of object (always 'work') - `const WorkWork Work = "work"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaSelfHostedWork, err := client.Beta.Environments.Work.Update( context.TODO(), "work_id", anthropic.BetaEnvironmentWorkUpdateParams{ EnvironmentID: "env_011CZkZ9X2dpNyB7HsEFoRfW", BetaSelfHostedWorkUpdateRequest: anthropic.BetaSelfHostedWorkUpdateRequestParam{ Metadata: map[string]string{ "foo": "string", }, }, }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaSelfHostedWork.ID) } ``` #### Response ```json { "id": "id", "acknowledged_at": "acknowledged_at", "created_at": "created_at", "data": { "id": "id", "type": "session" }, "environment_id": "environment_id", "latest_heartbeat_at": "latest_heartbeat_at", "metadata": { "foo": "string" }, "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ``` ## Get Queue Statistics `client.Beta.Environments.Work.Stats(ctx, environmentID, query) (*BetaSelfHostedWorkQueueStats, error)` **get** `/v1/environments/{environment_id}/work/stats` Get statistics about the work queue for an environment. ### Parameters - `environmentID string` - `query BetaEnvironmentWorkStatsParams` - `Betas param.Field[[]AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaSelfHostedWorkQueueStats struct{…}` Statistics about the work queue for an environment. Uses Redis Stream consumer group metrics for O(1) queries. - `Depth int64` Number of work items waiting to be picked up (lag from consumer group) - `OldestQueuedAt string` RFC 3339 timestamp of oldest item in the work stream (includes both queued and pending items), null if stream empty - `Pending int64` Number of work items being processed (polled but not acknowledged) - `Type WorkQueueStats` The type of object - `const WorkQueueStatsWorkQueueStats WorkQueueStats = "work_queue_stats"` - `WorkersPolling int64` Number of workers that have polled for work in the last 30 seconds. Requires worker_id to be sent with poll requests. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaSelfHostedWorkQueueStats, err := client.Beta.Environments.Work.Stats( context.TODO(), "env_011CZkZ9X2dpNyB7HsEFoRfW", anthropic.BetaEnvironmentWorkStatsParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaSelfHostedWorkQueueStats.Depth) } ``` #### Response ```json { "depth": 0, "oldest_queued_at": "oldest_queued_at", "pending": 0, "type": "work_queue_stats", "workers_polling": 0 } ``` ## Domain Types ### Beta Self Hosted Work - `type BetaSelfHostedWork struct{…}` Work resource representing a unit of work in a self-hosted environment. Work items are queued when sessions are created or when long-dormant sessions receive new messages. The environment worker polls for work to execute in a self-hosted sandbox. - `ID string` Work identifier (e.g., 'work_...') - `AcknowledgedAt string` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `CreatedAt string` RFC 3339 timestamp when work was created - `Data BetaSessionWorkData` The actual work to be performed - `ID string` Session identifier (e.g., 'session_...') - `Type Session` Type of work data - `const SessionSession Session = "session"` - `EnvironmentID string` Environment identifier this work belongs to (e.g., `env_...`) - `LatestHeartbeatAt string` RFC 3339 timestamp of the most recent heartbeat - `Metadata map[string, string]` User-provided metadata key-value pairs associated with this work item - `StartedAt string` RFC 3339 timestamp when work execution started - `State BetaSelfHostedWorkState` Current state of the work item - `const BetaSelfHostedWorkStateQueued BetaSelfHostedWorkState = "queued"` - `const BetaSelfHostedWorkStateStarting BetaSelfHostedWorkState = "starting"` - `const BetaSelfHostedWorkStateActive BetaSelfHostedWorkState = "active"` - `const BetaSelfHostedWorkStateStopping BetaSelfHostedWorkState = "stopping"` - `const BetaSelfHostedWorkStateStopped BetaSelfHostedWorkState = "stopped"` - `StopRequestedAt string` RFC 3339 timestamp when stop was requested - `StoppedAt string` RFC 3339 timestamp when work execution stopped - `Type Work` The type of object (always 'work') - `const WorkWork Work = "work"` ### Beta Self Hosted Work Heartbeat Response - `type BetaSelfHostedWorkHeartbeatResponse struct{…}` Response after recording a heartbeat for a work item. - `LastHeartbeat string` RFC 3339 timestamp of the actual heartbeat from DB - `LeaseExtended bool` Whether the heartbeat succeeded in extending the lease - `State BetaSelfHostedWorkHeartbeatResponseState` Current state of the work item (active/stopping/stopped) - `const BetaSelfHostedWorkHeartbeatResponseStateQueued BetaSelfHostedWorkHeartbeatResponseState = "queued"` - `const BetaSelfHostedWorkHeartbeatResponseStateStarting BetaSelfHostedWorkHeartbeatResponseState = "starting"` - `const BetaSelfHostedWorkHeartbeatResponseStateActive BetaSelfHostedWorkHeartbeatResponseState = "active"` - `const BetaSelfHostedWorkHeartbeatResponseStateStopping BetaSelfHostedWorkHeartbeatResponseState = "stopping"` - `const BetaSelfHostedWorkHeartbeatResponseStateStopped BetaSelfHostedWorkHeartbeatResponseState = "stopped"` - `TTLSeconds int64` Effective TTL applied to the lease - `Type WorkHeartbeat` The type of response - `const WorkHeartbeatWorkHeartbeat WorkHeartbeat = "work_heartbeat"` ### Beta Self Hosted Work List Response - `type BetaSelfHostedWorkListResponse struct{…}` Response when listing work items with cursor-based pagination. - `Data []BetaSelfHostedWork` List of work items - `ID string` Work identifier (e.g., 'work_...') - `AcknowledgedAt string` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `CreatedAt string` RFC 3339 timestamp when work was created - `Data BetaSessionWorkData` The actual work to be performed - `ID string` Session identifier (e.g., 'session_...') - `Type Session` Type of work data - `const SessionSession Session = "session"` - `EnvironmentID string` Environment identifier this work belongs to (e.g., `env_...`) - `LatestHeartbeatAt string` RFC 3339 timestamp of the most recent heartbeat - `Metadata map[string, string]` User-provided metadata key-value pairs associated with this work item - `StartedAt string` RFC 3339 timestamp when work execution started - `State BetaSelfHostedWorkState` Current state of the work item - `const BetaSelfHostedWorkStateQueued BetaSelfHostedWorkState = "queued"` - `const BetaSelfHostedWorkStateStarting BetaSelfHostedWorkState = "starting"` - `const BetaSelfHostedWorkStateActive BetaSelfHostedWorkState = "active"` - `const BetaSelfHostedWorkStateStopping BetaSelfHostedWorkState = "stopping"` - `const BetaSelfHostedWorkStateStopped BetaSelfHostedWorkState = "stopped"` - `StopRequestedAt string` RFC 3339 timestamp when stop was requested - `StoppedAt string` RFC 3339 timestamp when work execution stopped - `Type Work` The type of object (always 'work') - `const WorkWork Work = "work"` - `NextPage string` Opaque cursor for fetching the next page of results ### Beta Self Hosted Work Queue Stats - `type BetaSelfHostedWorkQueueStats struct{…}` Statistics about the work queue for an environment. Uses Redis Stream consumer group metrics for O(1) queries. - `Depth int64` Number of work items waiting to be picked up (lag from consumer group) - `OldestQueuedAt string` RFC 3339 timestamp of oldest item in the work stream (includes both queued and pending items), null if stream empty - `Pending int64` Number of work items being processed (polled but not acknowledged) - `Type WorkQueueStats` The type of object - `const WorkQueueStatsWorkQueueStats WorkQueueStats = "work_queue_stats"` - `WorkersPolling int64` Number of workers that have polled for work in the last 30 seconds. Requires worker_id to be sent with poll requests. ### Beta Self Hosted Work Stop Request - `type BetaSelfHostedWorkStopRequest struct{…}` Request to stop a work item. - `Force bool` If true, immediately stop work without graceful shutdown ### Beta Self Hosted Work Update Request - `type BetaSelfHostedWorkUpdateRequest struct{…}` Request to update work item metadata. - `Metadata map[string, string]` Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve existing metadata. ### Beta Session Work Data - `type BetaSessionWorkData struct{…}` Work data for session work items. This resource type is used when work represents a session that needs to be executed in a self-hosted environment. - `ID string` Session identifier (e.g., 'session_...') - `Type Session` Type of work data - `const SessionSession Session = "session"` # Sessions ## Create Session `client.Beta.Sessions.New(ctx, params) (*BetaManagedAgentsSession, error)` **post** `/v1/sessions` Create Session ### Parameters - `params BetaSessionNewParams` - `Agent param.Field[BetaSessionNewParamsAgentUnion]` Body param: Agent identifier. Accepts the `agent` ID string, which pins the latest version for the session, or an `agent` object with both id and version specified. - `string` - `type BetaManagedAgentsAgentParamsResp struct{…}` Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version - `ID string` The `agent` ID. - `Type BetaManagedAgentsAgentParamsType` - `const BetaManagedAgentsAgentParamsTypeAgent BetaManagedAgentsAgentParamsType = "agent"` - `Version int64` The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified. - `EnvironmentID param.Field[string]` Body param: ID of the `environment` defining the container configuration for this session. - `Metadata param.Field[map[string, string]]` Body param: Arbitrary key-value metadata attached to the session. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `Resources param.Field[[]BetaSessionNewParamsResourceUnion]` Body param: Resources (e.g. repositories, files) to mount into the session's container. - `type BetaManagedAgentsGitHubRepositoryResourceParamsResp struct{…}` Mount a GitHub repository into the session's container. - `AuthorizationToken string` GitHub authorization token used to clone the repository. - `Type BetaManagedAgentsGitHubRepositoryResourceParamsType` - `const BetaManagedAgentsGitHubRepositoryResourceParamsTypeGitHubRepository BetaManagedAgentsGitHubRepositoryResourceParamsType = "github_repository"` - `URL string` Github URL of the repository - `Checkout BetaManagedAgentsGitHubRepositoryResourceParamsCheckoutUnionResp` Branch or commit to check out. Defaults to the repository's default branch. - `type BetaManagedAgentsBranchCheckout struct{…}` - `Name string` Branch name to check out. - `Type BetaManagedAgentsBranchCheckoutType` - `const BetaManagedAgentsBranchCheckoutTypeBranch BetaManagedAgentsBranchCheckoutType = "branch"` - `type BetaManagedAgentsCommitCheckout struct{…}` - `Sha string` Full commit SHA to check out. - `Type BetaManagedAgentsCommitCheckoutType` - `const BetaManagedAgentsCommitCheckoutTypeCommit BetaManagedAgentsCommitCheckoutType = "commit"` - `MountPath string` Mount path in the container. Defaults to `/workspace/`. - `type BetaManagedAgentsFileResourceParamsResp struct{…}` Mount a file uploaded via the Files API into the session. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileResourceParamsType` - `const BetaManagedAgentsFileResourceParamsTypeFile BetaManagedAgentsFileResourceParamsType = "file"` - `MountPath string` Mount path in the container. Defaults to `/mnt/session/uploads/`. - `type BetaManagedAgentsMemoryStoreResourceParamResp struct{…}` Parameters for attaching a memory store to an agent session. - `MemoryStoreID string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `Type BetaManagedAgentsMemoryStoreResourceParamType` - `const BetaManagedAgentsMemoryStoreResourceParamTypeMemoryStore BetaManagedAgentsMemoryStoreResourceParamType = "memory_store"` - `Access BetaManagedAgentsMemoryStoreResourceParamAccess` Access mode for an attached memory store. - `const BetaManagedAgentsMemoryStoreResourceParamAccessReadWrite BetaManagedAgentsMemoryStoreResourceParamAccess = "read_write"` - `const BetaManagedAgentsMemoryStoreResourceParamAccessReadOnly BetaManagedAgentsMemoryStoreResourceParamAccess = "read_only"` - `Instructions string` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `Title param.Field[string]` Body param: Human-readable session title. - `VaultIDs param.Field[[]string]` Body param: Vault IDs for stored credentials the agent can use during the session. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsSession struct{…}` A Managed Agents `session`. - `ID string` - `Agent BetaManagedAgentsSessionAgent` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Multiagent BetaManagedAgentsSessionMultiagentCoordinator` Resolved coordinator topology with full agent definitions for each roster member. - `Agents []BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `Name string` - `Skills []BetaManagedAgentsSessionThreadAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsSessionThreadAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsSessionThreadAgentType` - `const BetaManagedAgentsSessionThreadAgentTypeAgent BetaManagedAgentsSessionThreadAgentType = "agent"` - `Version int64` - `Type BetaManagedAgentsSessionMultiagentCoordinatorType` - `const BetaManagedAgentsSessionMultiagentCoordinatorTypeCoordinator BetaManagedAgentsSessionMultiagentCoordinatorType = "coordinator"` - `Name string` - `Skills []BetaManagedAgentsSessionAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `System string` - `Tools []BetaManagedAgentsSessionAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `type BetaManagedAgentsMCPToolset struct{…}` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Type BetaManagedAgentsSessionAgentType` - `const BetaManagedAgentsSessionAgentTypeAgent BetaManagedAgentsSessionAgentType = "agent"` - `Version int64` - `ArchivedAt Time` A timestamp in RFC 3339 format - `CreatedAt Time` A timestamp in RFC 3339 format - `EnvironmentID string` - `Metadata map[string, string]` - `OutcomeEvaluations []BetaManagedAgentsOutcomeEvaluationResource` Per-outcome evaluation state. One entry per define_outcome event sent to the session. - `CompletedAt Time` A timestamp in RFC 3339 format - `Description string` What the agent should produce. - `Explanation string` Grader's verdict text from the most recent evaluation. For satisfied, explains why criteria are met; for needs_revision (intermediate), what's missing; for failed, why unrecoverable. - `Iteration int64` 0-indexed revision cycle the outcome is currently on. - `OutcomeID string` Server-generated outc_ ID for this outcome. - `Result string` Current evaluation state. `pending` before the agent begins work; `running` while producing or revising; `evaluating` while the grader scores; `satisfied`/`max_iterations_reached`/`failed`/`interrupted` are terminal. - `Type BetaManagedAgentsOutcomeEvaluationResourceType` - `const BetaManagedAgentsOutcomeEvaluationResourceTypeOutcomeEvaluation BetaManagedAgentsOutcomeEvaluationResourceType = "outcome_evaluation"` - `Resources []BetaManagedAgentsSessionResourceUnion` - `type BetaManagedAgentsGitHubRepositoryResource struct{…}` - `ID string` - `CreatedAt Time` A timestamp in RFC 3339 format - `MountPath string` - `Type BetaManagedAgentsGitHubRepositoryResourceType` - `const BetaManagedAgentsGitHubRepositoryResourceTypeGitHubRepository BetaManagedAgentsGitHubRepositoryResourceType = "github_repository"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `URL string` - `Checkout BetaManagedAgentsGitHubRepositoryResourceCheckoutUnion` - `type BetaManagedAgentsBranchCheckout struct{…}` - `Name string` Branch name to check out. - `Type BetaManagedAgentsBranchCheckoutType` - `const BetaManagedAgentsBranchCheckoutTypeBranch BetaManagedAgentsBranchCheckoutType = "branch"` - `type BetaManagedAgentsCommitCheckout struct{…}` - `Sha string` Full commit SHA to check out. - `Type BetaManagedAgentsCommitCheckoutType` - `const BetaManagedAgentsCommitCheckoutTypeCommit BetaManagedAgentsCommitCheckoutType = "commit"` - `type BetaManagedAgentsFileResource struct{…}` - `ID string` - `CreatedAt Time` A timestamp in RFC 3339 format - `FileID string` - `MountPath string` - `Type BetaManagedAgentsFileResourceType` - `const BetaManagedAgentsFileResourceTypeFile BetaManagedAgentsFileResourceType = "file"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `type BetaManagedAgentsMemoryStoreResource struct{…}` A memory store attached to an agent session. - `MemoryStoreID string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `Type BetaManagedAgentsMemoryStoreResourceType` - `const BetaManagedAgentsMemoryStoreResourceTypeMemoryStore BetaManagedAgentsMemoryStoreResourceType = "memory_store"` - `Access BetaManagedAgentsMemoryStoreResourceAccess` Access mode for an attached memory store. - `const BetaManagedAgentsMemoryStoreResourceAccessReadWrite BetaManagedAgentsMemoryStoreResourceAccess = "read_write"` - `const BetaManagedAgentsMemoryStoreResourceAccessReadOnly BetaManagedAgentsMemoryStoreResourceAccess = "read_only"` - `Description string` Description of the memory store, snapshotted at attach time. Rendered into the agent's system prompt. Empty string when the store has no description. - `Instructions string` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `MountPath string` Filesystem path where the store is mounted in the session container, e.g. /mnt/memory/user-preferences. Derived from the store's name. Output-only. - `Name string` Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. - `Stats BetaManagedAgentsSessionStats` Timing statistics for a session. - `ActiveSeconds float64` Cumulative time in seconds the session spent in running status. Excludes idle time. - `DurationSeconds float64` Elapsed time since session creation in seconds. For terminated sessions, frozen at the final update. - `Status BetaManagedAgentsSessionStatus` SessionStatus enum - `const BetaManagedAgentsSessionStatusRescheduling BetaManagedAgentsSessionStatus = "rescheduling"` - `const BetaManagedAgentsSessionStatusRunning BetaManagedAgentsSessionStatus = "running"` - `const BetaManagedAgentsSessionStatusIdle BetaManagedAgentsSessionStatus = "idle"` - `const BetaManagedAgentsSessionStatusTerminated BetaManagedAgentsSessionStatus = "terminated"` - `Title string` - `Type BetaManagedAgentsSessionType` - `const BetaManagedAgentsSessionTypeSession BetaManagedAgentsSessionType = "session"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `Usage BetaManagedAgentsSessionUsage` Cumulative token usage for a session across all turns. - `CacheCreation BetaManagedAgentsCacheCreationUsage` Prompt-cache creation token usage broken down by cache lifetime. - `Ephemeral1hInputTokens int64` Tokens used to create 1-hour ephemeral cache entries. - `Ephemeral5mInputTokens int64` Tokens used to create 5-minute ephemeral cache entries. - `CacheReadInputTokens int64` Total tokens read from prompt cache. - `InputTokens int64` Total input tokens consumed across all turns. - `OutputTokens int64` Total output tokens generated across all turns. - `VaultIDs []string` Vault IDs attached to the session at creation. Empty when no vaults were supplied. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsSession, err := client.Beta.Sessions.New(context.TODO(), anthropic.BetaSessionNewParams{ Agent: anthropic.BetaSessionNewParamsAgentUnion{ OfString: anthropic.String("agent_011CZkYpogX7uDKUyvBTophP"), }, EnvironmentID: "env_011CZkZ9X2dpNyB7HsEFoRfW", }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsSession.ID) } ``` #### Response ```json { "id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "name": "Researcher", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" } ], "system": "You are a research subagent that gathers and summarises sources for the coordinating agent.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "metadata": {}, "outcome_evaluations": [ { "completed_at": "2026-03-15T10:02:31Z", "description": "Produce a 2-page summary as summary.md", "explanation": "All five sections present with inline citations.", "iteration": 0, "outcome_id": "outc_011CZkZRSw2kEfs6ncTVljxP", "result": "satisfied", "type": "outcome_evaluation" } ], "resources": [ { "id": "sesrsc_011CZkZBJq5dWxk9fVLNcPht", "created_at": "2026-03-15T10:00:00Z", "file_id": "file_011CNha8iCJcU1wXNR6q4V8w", "mount_path": "/uploads/receipt.pdf", "type": "file", "updated_at": "2026-03-15T10:00:00Z" }, { "id": "sesrsc_011CZkZCKr6eXyl0gWMOdQiu", "created_at": "2026-03-15T10:00:00Z", "mount_path": "/workspace/example-repo", "type": "github_repository", "updated_at": "2026-03-15T10:00:00Z", "url": "https://github.com/example-org/example-repo", "checkout": { "name": "main", "type": "branch" } } ], "stats": { "active_seconds": 0, "duration_seconds": 0 }, "status": "idle", "title": "Order #1234 inquiry", "type": "session", "updated_at": "2026-03-15T10:00:00Z", "usage": { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0 }, "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ] } ``` ## List Sessions `client.Beta.Sessions.List(ctx, params) (*PageCursor[BetaManagedAgentsSession], error)` **get** `/v1/sessions` List Sessions ### Parameters - `params BetaSessionListParams` - `AgentID param.Field[string]` Query param: Filter sessions created with this agent ID. - `AgentVersion param.Field[int64]` Query param: Filter by agent version. Only applies when agent_id is also set. - `CreatedAtGt param.Field[Time]` Query param: Return sessions created after this time (exclusive). - `CreatedAtGte param.Field[Time]` Query param: Return sessions created at or after this time (inclusive). - `CreatedAtLt param.Field[Time]` Query param: Return sessions created before this time (exclusive). - `CreatedAtLte param.Field[Time]` Query param: Return sessions created at or before this time (inclusive). - `IncludeArchived param.Field[bool]` Query param: When true, includes archived sessions. Default: false (exclude archived). - `Limit param.Field[int64]` Query param: Maximum number of results to return. - `MemoryStoreID param.Field[string]` Query param: Filter sessions whose resources contain a memory_store with this memory store ID. - `Order param.Field[BetaSessionListParamsOrder]` Query param: Sort direction for results, ordered by created_at. Defaults to desc (newest first). - `const BetaSessionListParamsOrderAsc BetaSessionListParamsOrder = "asc"` - `const BetaSessionListParamsOrderDesc BetaSessionListParamsOrder = "desc"` - `Page param.Field[string]` Query param: Opaque pagination cursor from a previous response's next_page. - `Statuses param.Field[[]string]` Query param: Filter by session status. Repeat the parameter to match any of multiple statuses. - `const BetaSessionListParamsStatusRescheduling BetaSessionListParamsStatus = "rescheduling"` - `const BetaSessionListParamsStatusRunning BetaSessionListParamsStatus = "running"` - `const BetaSessionListParamsStatusIdle BetaSessionListParamsStatus = "idle"` - `const BetaSessionListParamsStatusTerminated BetaSessionListParamsStatus = "terminated"` - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsSession struct{…}` A Managed Agents `session`. - `ID string` - `Agent BetaManagedAgentsSessionAgent` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Multiagent BetaManagedAgentsSessionMultiagentCoordinator` Resolved coordinator topology with full agent definitions for each roster member. - `Agents []BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `Name string` - `Skills []BetaManagedAgentsSessionThreadAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsSessionThreadAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsSessionThreadAgentType` - `const BetaManagedAgentsSessionThreadAgentTypeAgent BetaManagedAgentsSessionThreadAgentType = "agent"` - `Version int64` - `Type BetaManagedAgentsSessionMultiagentCoordinatorType` - `const BetaManagedAgentsSessionMultiagentCoordinatorTypeCoordinator BetaManagedAgentsSessionMultiagentCoordinatorType = "coordinator"` - `Name string` - `Skills []BetaManagedAgentsSessionAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `System string` - `Tools []BetaManagedAgentsSessionAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `type BetaManagedAgentsMCPToolset struct{…}` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Type BetaManagedAgentsSessionAgentType` - `const BetaManagedAgentsSessionAgentTypeAgent BetaManagedAgentsSessionAgentType = "agent"` - `Version int64` - `ArchivedAt Time` A timestamp in RFC 3339 format - `CreatedAt Time` A timestamp in RFC 3339 format - `EnvironmentID string` - `Metadata map[string, string]` - `OutcomeEvaluations []BetaManagedAgentsOutcomeEvaluationResource` Per-outcome evaluation state. One entry per define_outcome event sent to the session. - `CompletedAt Time` A timestamp in RFC 3339 format - `Description string` What the agent should produce. - `Explanation string` Grader's verdict text from the most recent evaluation. For satisfied, explains why criteria are met; for needs_revision (intermediate), what's missing; for failed, why unrecoverable. - `Iteration int64` 0-indexed revision cycle the outcome is currently on. - `OutcomeID string` Server-generated outc_ ID for this outcome. - `Result string` Current evaluation state. `pending` before the agent begins work; `running` while producing or revising; `evaluating` while the grader scores; `satisfied`/`max_iterations_reached`/`failed`/`interrupted` are terminal. - `Type BetaManagedAgentsOutcomeEvaluationResourceType` - `const BetaManagedAgentsOutcomeEvaluationResourceTypeOutcomeEvaluation BetaManagedAgentsOutcomeEvaluationResourceType = "outcome_evaluation"` - `Resources []BetaManagedAgentsSessionResourceUnion` - `type BetaManagedAgentsGitHubRepositoryResource struct{…}` - `ID string` - `CreatedAt Time` A timestamp in RFC 3339 format - `MountPath string` - `Type BetaManagedAgentsGitHubRepositoryResourceType` - `const BetaManagedAgentsGitHubRepositoryResourceTypeGitHubRepository BetaManagedAgentsGitHubRepositoryResourceType = "github_repository"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `URL string` - `Checkout BetaManagedAgentsGitHubRepositoryResourceCheckoutUnion` - `type BetaManagedAgentsBranchCheckout struct{…}` - `Name string` Branch name to check out. - `Type BetaManagedAgentsBranchCheckoutType` - `const BetaManagedAgentsBranchCheckoutTypeBranch BetaManagedAgentsBranchCheckoutType = "branch"` - `type BetaManagedAgentsCommitCheckout struct{…}` - `Sha string` Full commit SHA to check out. - `Type BetaManagedAgentsCommitCheckoutType` - `const BetaManagedAgentsCommitCheckoutTypeCommit BetaManagedAgentsCommitCheckoutType = "commit"` - `type BetaManagedAgentsFileResource struct{…}` - `ID string` - `CreatedAt Time` A timestamp in RFC 3339 format - `FileID string` - `MountPath string` - `Type BetaManagedAgentsFileResourceType` - `const BetaManagedAgentsFileResourceTypeFile BetaManagedAgentsFileResourceType = "file"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `type BetaManagedAgentsMemoryStoreResource struct{…}` A memory store attached to an agent session. - `MemoryStoreID string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `Type BetaManagedAgentsMemoryStoreResourceType` - `const BetaManagedAgentsMemoryStoreResourceTypeMemoryStore BetaManagedAgentsMemoryStoreResourceType = "memory_store"` - `Access BetaManagedAgentsMemoryStoreResourceAccess` Access mode for an attached memory store. - `const BetaManagedAgentsMemoryStoreResourceAccessReadWrite BetaManagedAgentsMemoryStoreResourceAccess = "read_write"` - `const BetaManagedAgentsMemoryStoreResourceAccessReadOnly BetaManagedAgentsMemoryStoreResourceAccess = "read_only"` - `Description string` Description of the memory store, snapshotted at attach time. Rendered into the agent's system prompt. Empty string when the store has no description. - `Instructions string` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `MountPath string` Filesystem path where the store is mounted in the session container, e.g. /mnt/memory/user-preferences. Derived from the store's name. Output-only. - `Name string` Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. - `Stats BetaManagedAgentsSessionStats` Timing statistics for a session. - `ActiveSeconds float64` Cumulative time in seconds the session spent in running status. Excludes idle time. - `DurationSeconds float64` Elapsed time since session creation in seconds. For terminated sessions, frozen at the final update. - `Status BetaManagedAgentsSessionStatus` SessionStatus enum - `const BetaManagedAgentsSessionStatusRescheduling BetaManagedAgentsSessionStatus = "rescheduling"` - `const BetaManagedAgentsSessionStatusRunning BetaManagedAgentsSessionStatus = "running"` - `const BetaManagedAgentsSessionStatusIdle BetaManagedAgentsSessionStatus = "idle"` - `const BetaManagedAgentsSessionStatusTerminated BetaManagedAgentsSessionStatus = "terminated"` - `Title string` - `Type BetaManagedAgentsSessionType` - `const BetaManagedAgentsSessionTypeSession BetaManagedAgentsSessionType = "session"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `Usage BetaManagedAgentsSessionUsage` Cumulative token usage for a session across all turns. - `CacheCreation BetaManagedAgentsCacheCreationUsage` Prompt-cache creation token usage broken down by cache lifetime. - `Ephemeral1hInputTokens int64` Tokens used to create 1-hour ephemeral cache entries. - `Ephemeral5mInputTokens int64` Tokens used to create 5-minute ephemeral cache entries. - `CacheReadInputTokens int64` Total tokens read from prompt cache. - `InputTokens int64` Total input tokens consumed across all turns. - `OutputTokens int64` Total output tokens generated across all turns. - `VaultIDs []string` Vault IDs attached to the session at creation. Empty when no vaults were supplied. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) page, err := client.Beta.Sessions.List(context.TODO(), anthropic.BetaSessionListParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "data": [ { "id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "name": "Researcher", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" } ], "system": "You are a research subagent that gathers and summarises sources for the coordinating agent.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "metadata": {}, "outcome_evaluations": [ { "completed_at": "2026-03-15T10:02:31Z", "description": "Produce a 2-page summary as summary.md", "explanation": "All five sections present with inline citations.", "iteration": 0, "outcome_id": "outc_011CZkZRSw2kEfs6ncTVljxP", "result": "satisfied", "type": "outcome_evaluation" } ], "resources": [ { "id": "sesrsc_011CZkZBJq5dWxk9fVLNcPht", "created_at": "2026-03-15T10:00:00Z", "file_id": "file_011CNha8iCJcU1wXNR6q4V8w", "mount_path": "/uploads/receipt.pdf", "type": "file", "updated_at": "2026-03-15T10:00:00Z" }, { "id": "sesrsc_011CZkZCKr6eXyl0gWMOdQiu", "created_at": "2026-03-15T10:00:00Z", "mount_path": "/workspace/example-repo", "type": "github_repository", "updated_at": "2026-03-15T10:00:00Z", "url": "https://github.com/example-org/example-repo", "checkout": { "name": "main", "type": "branch" } } ], "stats": { "active_seconds": 0, "duration_seconds": 0 }, "status": "idle", "title": "Order #1234 inquiry", "type": "session", "updated_at": "2026-03-15T10:00:00Z", "usage": { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0 }, "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ] } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ## Get Session `client.Beta.Sessions.Get(ctx, sessionID, query) (*BetaManagedAgentsSession, error)` **get** `/v1/sessions/{session_id}` Get Session ### Parameters - `sessionID string` - `query BetaSessionGetParams` - `Betas param.Field[[]AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsSession struct{…}` A Managed Agents `session`. - `ID string` - `Agent BetaManagedAgentsSessionAgent` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Multiagent BetaManagedAgentsSessionMultiagentCoordinator` Resolved coordinator topology with full agent definitions for each roster member. - `Agents []BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `Name string` - `Skills []BetaManagedAgentsSessionThreadAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsSessionThreadAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsSessionThreadAgentType` - `const BetaManagedAgentsSessionThreadAgentTypeAgent BetaManagedAgentsSessionThreadAgentType = "agent"` - `Version int64` - `Type BetaManagedAgentsSessionMultiagentCoordinatorType` - `const BetaManagedAgentsSessionMultiagentCoordinatorTypeCoordinator BetaManagedAgentsSessionMultiagentCoordinatorType = "coordinator"` - `Name string` - `Skills []BetaManagedAgentsSessionAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `System string` - `Tools []BetaManagedAgentsSessionAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `type BetaManagedAgentsMCPToolset struct{…}` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Type BetaManagedAgentsSessionAgentType` - `const BetaManagedAgentsSessionAgentTypeAgent BetaManagedAgentsSessionAgentType = "agent"` - `Version int64` - `ArchivedAt Time` A timestamp in RFC 3339 format - `CreatedAt Time` A timestamp in RFC 3339 format - `EnvironmentID string` - `Metadata map[string, string]` - `OutcomeEvaluations []BetaManagedAgentsOutcomeEvaluationResource` Per-outcome evaluation state. One entry per define_outcome event sent to the session. - `CompletedAt Time` A timestamp in RFC 3339 format - `Description string` What the agent should produce. - `Explanation string` Grader's verdict text from the most recent evaluation. For satisfied, explains why criteria are met; for needs_revision (intermediate), what's missing; for failed, why unrecoverable. - `Iteration int64` 0-indexed revision cycle the outcome is currently on. - `OutcomeID string` Server-generated outc_ ID for this outcome. - `Result string` Current evaluation state. `pending` before the agent begins work; `running` while producing or revising; `evaluating` while the grader scores; `satisfied`/`max_iterations_reached`/`failed`/`interrupted` are terminal. - `Type BetaManagedAgentsOutcomeEvaluationResourceType` - `const BetaManagedAgentsOutcomeEvaluationResourceTypeOutcomeEvaluation BetaManagedAgentsOutcomeEvaluationResourceType = "outcome_evaluation"` - `Resources []BetaManagedAgentsSessionResourceUnion` - `type BetaManagedAgentsGitHubRepositoryResource struct{…}` - `ID string` - `CreatedAt Time` A timestamp in RFC 3339 format - `MountPath string` - `Type BetaManagedAgentsGitHubRepositoryResourceType` - `const BetaManagedAgentsGitHubRepositoryResourceTypeGitHubRepository BetaManagedAgentsGitHubRepositoryResourceType = "github_repository"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `URL string` - `Checkout BetaManagedAgentsGitHubRepositoryResourceCheckoutUnion` - `type BetaManagedAgentsBranchCheckout struct{…}` - `Name string` Branch name to check out. - `Type BetaManagedAgentsBranchCheckoutType` - `const BetaManagedAgentsBranchCheckoutTypeBranch BetaManagedAgentsBranchCheckoutType = "branch"` - `type BetaManagedAgentsCommitCheckout struct{…}` - `Sha string` Full commit SHA to check out. - `Type BetaManagedAgentsCommitCheckoutType` - `const BetaManagedAgentsCommitCheckoutTypeCommit BetaManagedAgentsCommitCheckoutType = "commit"` - `type BetaManagedAgentsFileResource struct{…}` - `ID string` - `CreatedAt Time` A timestamp in RFC 3339 format - `FileID string` - `MountPath string` - `Type BetaManagedAgentsFileResourceType` - `const BetaManagedAgentsFileResourceTypeFile BetaManagedAgentsFileResourceType = "file"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `type BetaManagedAgentsMemoryStoreResource struct{…}` A memory store attached to an agent session. - `MemoryStoreID string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `Type BetaManagedAgentsMemoryStoreResourceType` - `const BetaManagedAgentsMemoryStoreResourceTypeMemoryStore BetaManagedAgentsMemoryStoreResourceType = "memory_store"` - `Access BetaManagedAgentsMemoryStoreResourceAccess` Access mode for an attached memory store. - `const BetaManagedAgentsMemoryStoreResourceAccessReadWrite BetaManagedAgentsMemoryStoreResourceAccess = "read_write"` - `const BetaManagedAgentsMemoryStoreResourceAccessReadOnly BetaManagedAgentsMemoryStoreResourceAccess = "read_only"` - `Description string` Description of the memory store, snapshotted at attach time. Rendered into the agent's system prompt. Empty string when the store has no description. - `Instructions string` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `MountPath string` Filesystem path where the store is mounted in the session container, e.g. /mnt/memory/user-preferences. Derived from the store's name. Output-only. - `Name string` Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. - `Stats BetaManagedAgentsSessionStats` Timing statistics for a session. - `ActiveSeconds float64` Cumulative time in seconds the session spent in running status. Excludes idle time. - `DurationSeconds float64` Elapsed time since session creation in seconds. For terminated sessions, frozen at the final update. - `Status BetaManagedAgentsSessionStatus` SessionStatus enum - `const BetaManagedAgentsSessionStatusRescheduling BetaManagedAgentsSessionStatus = "rescheduling"` - `const BetaManagedAgentsSessionStatusRunning BetaManagedAgentsSessionStatus = "running"` - `const BetaManagedAgentsSessionStatusIdle BetaManagedAgentsSessionStatus = "idle"` - `const BetaManagedAgentsSessionStatusTerminated BetaManagedAgentsSessionStatus = "terminated"` - `Title string` - `Type BetaManagedAgentsSessionType` - `const BetaManagedAgentsSessionTypeSession BetaManagedAgentsSessionType = "session"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `Usage BetaManagedAgentsSessionUsage` Cumulative token usage for a session across all turns. - `CacheCreation BetaManagedAgentsCacheCreationUsage` Prompt-cache creation token usage broken down by cache lifetime. - `Ephemeral1hInputTokens int64` Tokens used to create 1-hour ephemeral cache entries. - `Ephemeral5mInputTokens int64` Tokens used to create 5-minute ephemeral cache entries. - `CacheReadInputTokens int64` Total tokens read from prompt cache. - `InputTokens int64` Total input tokens consumed across all turns. - `OutputTokens int64` Total output tokens generated across all turns. - `VaultIDs []string` Vault IDs attached to the session at creation. Empty when no vaults were supplied. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsSession, err := client.Beta.Sessions.Get( context.TODO(), "sesn_011CZkZAtmR3yMPDzynEDxu7", anthropic.BetaSessionGetParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsSession.ID) } ``` #### Response ```json { "id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "name": "Researcher", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" } ], "system": "You are a research subagent that gathers and summarises sources for the coordinating agent.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "metadata": {}, "outcome_evaluations": [ { "completed_at": "2026-03-15T10:02:31Z", "description": "Produce a 2-page summary as summary.md", "explanation": "All five sections present with inline citations.", "iteration": 0, "outcome_id": "outc_011CZkZRSw2kEfs6ncTVljxP", "result": "satisfied", "type": "outcome_evaluation" } ], "resources": [ { "id": "sesrsc_011CZkZBJq5dWxk9fVLNcPht", "created_at": "2026-03-15T10:00:00Z", "file_id": "file_011CNha8iCJcU1wXNR6q4V8w", "mount_path": "/uploads/receipt.pdf", "type": "file", "updated_at": "2026-03-15T10:00:00Z" }, { "id": "sesrsc_011CZkZCKr6eXyl0gWMOdQiu", "created_at": "2026-03-15T10:00:00Z", "mount_path": "/workspace/example-repo", "type": "github_repository", "updated_at": "2026-03-15T10:00:00Z", "url": "https://github.com/example-org/example-repo", "checkout": { "name": "main", "type": "branch" } } ], "stats": { "active_seconds": 0, "duration_seconds": 0 }, "status": "idle", "title": "Order #1234 inquiry", "type": "session", "updated_at": "2026-03-15T10:00:00Z", "usage": { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0 }, "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ] } ``` ## Update Session `client.Beta.Sessions.Update(ctx, sessionID, params) (*BetaManagedAgentsSession, error)` **post** `/v1/sessions/{session_id}` Update Session ### Parameters - `sessionID string` - `params BetaSessionUpdateParams` - `Agent param.Field[BetaManagedAgentsSessionAgentUpdate]` Body param: Mid-session agent configuration update. Only `tools` and `mcp_servers` are updatable. Full replacement: the provided array becomes the new value. To preserve existing entries, GET the session, modify the array, and POST it back. - `Metadata param.Field[map[string, string]]` Body param: Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve. - `Title param.Field[string]` Body param: Human-readable session title. - `VaultIDs param.Field[[]string]` Body param: Vault IDs (`vlt_*`) to attach to the session. Not yet supported; requests setting this field are rejected. Reserved for future use. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsSession struct{…}` A Managed Agents `session`. - `ID string` - `Agent BetaManagedAgentsSessionAgent` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Multiagent BetaManagedAgentsSessionMultiagentCoordinator` Resolved coordinator topology with full agent definitions for each roster member. - `Agents []BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `Name string` - `Skills []BetaManagedAgentsSessionThreadAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsSessionThreadAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsSessionThreadAgentType` - `const BetaManagedAgentsSessionThreadAgentTypeAgent BetaManagedAgentsSessionThreadAgentType = "agent"` - `Version int64` - `Type BetaManagedAgentsSessionMultiagentCoordinatorType` - `const BetaManagedAgentsSessionMultiagentCoordinatorTypeCoordinator BetaManagedAgentsSessionMultiagentCoordinatorType = "coordinator"` - `Name string` - `Skills []BetaManagedAgentsSessionAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `System string` - `Tools []BetaManagedAgentsSessionAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `type BetaManagedAgentsMCPToolset struct{…}` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Type BetaManagedAgentsSessionAgentType` - `const BetaManagedAgentsSessionAgentTypeAgent BetaManagedAgentsSessionAgentType = "agent"` - `Version int64` - `ArchivedAt Time` A timestamp in RFC 3339 format - `CreatedAt Time` A timestamp in RFC 3339 format - `EnvironmentID string` - `Metadata map[string, string]` - `OutcomeEvaluations []BetaManagedAgentsOutcomeEvaluationResource` Per-outcome evaluation state. One entry per define_outcome event sent to the session. - `CompletedAt Time` A timestamp in RFC 3339 format - `Description string` What the agent should produce. - `Explanation string` Grader's verdict text from the most recent evaluation. For satisfied, explains why criteria are met; for needs_revision (intermediate), what's missing; for failed, why unrecoverable. - `Iteration int64` 0-indexed revision cycle the outcome is currently on. - `OutcomeID string` Server-generated outc_ ID for this outcome. - `Result string` Current evaluation state. `pending` before the agent begins work; `running` while producing or revising; `evaluating` while the grader scores; `satisfied`/`max_iterations_reached`/`failed`/`interrupted` are terminal. - `Type BetaManagedAgentsOutcomeEvaluationResourceType` - `const BetaManagedAgentsOutcomeEvaluationResourceTypeOutcomeEvaluation BetaManagedAgentsOutcomeEvaluationResourceType = "outcome_evaluation"` - `Resources []BetaManagedAgentsSessionResourceUnion` - `type BetaManagedAgentsGitHubRepositoryResource struct{…}` - `ID string` - `CreatedAt Time` A timestamp in RFC 3339 format - `MountPath string` - `Type BetaManagedAgentsGitHubRepositoryResourceType` - `const BetaManagedAgentsGitHubRepositoryResourceTypeGitHubRepository BetaManagedAgentsGitHubRepositoryResourceType = "github_repository"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `URL string` - `Checkout BetaManagedAgentsGitHubRepositoryResourceCheckoutUnion` - `type BetaManagedAgentsBranchCheckout struct{…}` - `Name string` Branch name to check out. - `Type BetaManagedAgentsBranchCheckoutType` - `const BetaManagedAgentsBranchCheckoutTypeBranch BetaManagedAgentsBranchCheckoutType = "branch"` - `type BetaManagedAgentsCommitCheckout struct{…}` - `Sha string` Full commit SHA to check out. - `Type BetaManagedAgentsCommitCheckoutType` - `const BetaManagedAgentsCommitCheckoutTypeCommit BetaManagedAgentsCommitCheckoutType = "commit"` - `type BetaManagedAgentsFileResource struct{…}` - `ID string` - `CreatedAt Time` A timestamp in RFC 3339 format - `FileID string` - `MountPath string` - `Type BetaManagedAgentsFileResourceType` - `const BetaManagedAgentsFileResourceTypeFile BetaManagedAgentsFileResourceType = "file"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `type BetaManagedAgentsMemoryStoreResource struct{…}` A memory store attached to an agent session. - `MemoryStoreID string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `Type BetaManagedAgentsMemoryStoreResourceType` - `const BetaManagedAgentsMemoryStoreResourceTypeMemoryStore BetaManagedAgentsMemoryStoreResourceType = "memory_store"` - `Access BetaManagedAgentsMemoryStoreResourceAccess` Access mode for an attached memory store. - `const BetaManagedAgentsMemoryStoreResourceAccessReadWrite BetaManagedAgentsMemoryStoreResourceAccess = "read_write"` - `const BetaManagedAgentsMemoryStoreResourceAccessReadOnly BetaManagedAgentsMemoryStoreResourceAccess = "read_only"` - `Description string` Description of the memory store, snapshotted at attach time. Rendered into the agent's system prompt. Empty string when the store has no description. - `Instructions string` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `MountPath string` Filesystem path where the store is mounted in the session container, e.g. /mnt/memory/user-preferences. Derived from the store's name. Output-only. - `Name string` Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. - `Stats BetaManagedAgentsSessionStats` Timing statistics for a session. - `ActiveSeconds float64` Cumulative time in seconds the session spent in running status. Excludes idle time. - `DurationSeconds float64` Elapsed time since session creation in seconds. For terminated sessions, frozen at the final update. - `Status BetaManagedAgentsSessionStatus` SessionStatus enum - `const BetaManagedAgentsSessionStatusRescheduling BetaManagedAgentsSessionStatus = "rescheduling"` - `const BetaManagedAgentsSessionStatusRunning BetaManagedAgentsSessionStatus = "running"` - `const BetaManagedAgentsSessionStatusIdle BetaManagedAgentsSessionStatus = "idle"` - `const BetaManagedAgentsSessionStatusTerminated BetaManagedAgentsSessionStatus = "terminated"` - `Title string` - `Type BetaManagedAgentsSessionType` - `const BetaManagedAgentsSessionTypeSession BetaManagedAgentsSessionType = "session"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `Usage BetaManagedAgentsSessionUsage` Cumulative token usage for a session across all turns. - `CacheCreation BetaManagedAgentsCacheCreationUsage` Prompt-cache creation token usage broken down by cache lifetime. - `Ephemeral1hInputTokens int64` Tokens used to create 1-hour ephemeral cache entries. - `Ephemeral5mInputTokens int64` Tokens used to create 5-minute ephemeral cache entries. - `CacheReadInputTokens int64` Total tokens read from prompt cache. - `InputTokens int64` Total input tokens consumed across all turns. - `OutputTokens int64` Total output tokens generated across all turns. - `VaultIDs []string` Vault IDs attached to the session at creation. Empty when no vaults were supplied. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsSession, err := client.Beta.Sessions.Update( context.TODO(), "sesn_011CZkZAtmR3yMPDzynEDxu7", anthropic.BetaSessionUpdateParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsSession.ID) } ``` #### Response ```json { "id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "name": "Researcher", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" } ], "system": "You are a research subagent that gathers and summarises sources for the coordinating agent.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "metadata": {}, "outcome_evaluations": [ { "completed_at": "2026-03-15T10:02:31Z", "description": "Produce a 2-page summary as summary.md", "explanation": "All five sections present with inline citations.", "iteration": 0, "outcome_id": "outc_011CZkZRSw2kEfs6ncTVljxP", "result": "satisfied", "type": "outcome_evaluation" } ], "resources": [ { "id": "sesrsc_011CZkZBJq5dWxk9fVLNcPht", "created_at": "2026-03-15T10:00:00Z", "file_id": "file_011CNha8iCJcU1wXNR6q4V8w", "mount_path": "/uploads/receipt.pdf", "type": "file", "updated_at": "2026-03-15T10:00:00Z" }, { "id": "sesrsc_011CZkZCKr6eXyl0gWMOdQiu", "created_at": "2026-03-15T10:00:00Z", "mount_path": "/workspace/example-repo", "type": "github_repository", "updated_at": "2026-03-15T10:00:00Z", "url": "https://github.com/example-org/example-repo", "checkout": { "name": "main", "type": "branch" } } ], "stats": { "active_seconds": 0, "duration_seconds": 0 }, "status": "idle", "title": "Order #1234 inquiry", "type": "session", "updated_at": "2026-03-15T10:00:00Z", "usage": { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0 }, "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ] } ``` ## Delete Session `client.Beta.Sessions.Delete(ctx, sessionID, body) (*BetaManagedAgentsDeletedSession, error)` **delete** `/v1/sessions/{session_id}` Delete Session ### Parameters - `sessionID string` - `body BetaSessionDeleteParams` - `Betas param.Field[[]AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsDeletedSession struct{…}` Confirmation that a `session` has been permanently deleted. - `ID string` - `Type BetaManagedAgentsDeletedSessionType` - `const BetaManagedAgentsDeletedSessionTypeSessionDeleted BetaManagedAgentsDeletedSessionType = "session_deleted"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsDeletedSession, err := client.Beta.Sessions.Delete( context.TODO(), "sesn_011CZkZAtmR3yMPDzynEDxu7", anthropic.BetaSessionDeleteParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsDeletedSession.ID) } ``` #### Response ```json { "id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "type": "session_deleted" } ``` ## Archive Session `client.Beta.Sessions.Archive(ctx, sessionID, body) (*BetaManagedAgentsSession, error)` **post** `/v1/sessions/{session_id}/archive` Archive Session ### Parameters - `sessionID string` - `body BetaSessionArchiveParams` - `Betas param.Field[[]AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsSession struct{…}` A Managed Agents `session`. - `ID string` - `Agent BetaManagedAgentsSessionAgent` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Multiagent BetaManagedAgentsSessionMultiagentCoordinator` Resolved coordinator topology with full agent definitions for each roster member. - `Agents []BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `Name string` - `Skills []BetaManagedAgentsSessionThreadAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsSessionThreadAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsSessionThreadAgentType` - `const BetaManagedAgentsSessionThreadAgentTypeAgent BetaManagedAgentsSessionThreadAgentType = "agent"` - `Version int64` - `Type BetaManagedAgentsSessionMultiagentCoordinatorType` - `const BetaManagedAgentsSessionMultiagentCoordinatorTypeCoordinator BetaManagedAgentsSessionMultiagentCoordinatorType = "coordinator"` - `Name string` - `Skills []BetaManagedAgentsSessionAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `System string` - `Tools []BetaManagedAgentsSessionAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `type BetaManagedAgentsMCPToolset struct{…}` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Type BetaManagedAgentsSessionAgentType` - `const BetaManagedAgentsSessionAgentTypeAgent BetaManagedAgentsSessionAgentType = "agent"` - `Version int64` - `ArchivedAt Time` A timestamp in RFC 3339 format - `CreatedAt Time` A timestamp in RFC 3339 format - `EnvironmentID string` - `Metadata map[string, string]` - `OutcomeEvaluations []BetaManagedAgentsOutcomeEvaluationResource` Per-outcome evaluation state. One entry per define_outcome event sent to the session. - `CompletedAt Time` A timestamp in RFC 3339 format - `Description string` What the agent should produce. - `Explanation string` Grader's verdict text from the most recent evaluation. For satisfied, explains why criteria are met; for needs_revision (intermediate), what's missing; for failed, why unrecoverable. - `Iteration int64` 0-indexed revision cycle the outcome is currently on. - `OutcomeID string` Server-generated outc_ ID for this outcome. - `Result string` Current evaluation state. `pending` before the agent begins work; `running` while producing or revising; `evaluating` while the grader scores; `satisfied`/`max_iterations_reached`/`failed`/`interrupted` are terminal. - `Type BetaManagedAgentsOutcomeEvaluationResourceType` - `const BetaManagedAgentsOutcomeEvaluationResourceTypeOutcomeEvaluation BetaManagedAgentsOutcomeEvaluationResourceType = "outcome_evaluation"` - `Resources []BetaManagedAgentsSessionResourceUnion` - `type BetaManagedAgentsGitHubRepositoryResource struct{…}` - `ID string` - `CreatedAt Time` A timestamp in RFC 3339 format - `MountPath string` - `Type BetaManagedAgentsGitHubRepositoryResourceType` - `const BetaManagedAgentsGitHubRepositoryResourceTypeGitHubRepository BetaManagedAgentsGitHubRepositoryResourceType = "github_repository"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `URL string` - `Checkout BetaManagedAgentsGitHubRepositoryResourceCheckoutUnion` - `type BetaManagedAgentsBranchCheckout struct{…}` - `Name string` Branch name to check out. - `Type BetaManagedAgentsBranchCheckoutType` - `const BetaManagedAgentsBranchCheckoutTypeBranch BetaManagedAgentsBranchCheckoutType = "branch"` - `type BetaManagedAgentsCommitCheckout struct{…}` - `Sha string` Full commit SHA to check out. - `Type BetaManagedAgentsCommitCheckoutType` - `const BetaManagedAgentsCommitCheckoutTypeCommit BetaManagedAgentsCommitCheckoutType = "commit"` - `type BetaManagedAgentsFileResource struct{…}` - `ID string` - `CreatedAt Time` A timestamp in RFC 3339 format - `FileID string` - `MountPath string` - `Type BetaManagedAgentsFileResourceType` - `const BetaManagedAgentsFileResourceTypeFile BetaManagedAgentsFileResourceType = "file"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `type BetaManagedAgentsMemoryStoreResource struct{…}` A memory store attached to an agent session. - `MemoryStoreID string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `Type BetaManagedAgentsMemoryStoreResourceType` - `const BetaManagedAgentsMemoryStoreResourceTypeMemoryStore BetaManagedAgentsMemoryStoreResourceType = "memory_store"` - `Access BetaManagedAgentsMemoryStoreResourceAccess` Access mode for an attached memory store. - `const BetaManagedAgentsMemoryStoreResourceAccessReadWrite BetaManagedAgentsMemoryStoreResourceAccess = "read_write"` - `const BetaManagedAgentsMemoryStoreResourceAccessReadOnly BetaManagedAgentsMemoryStoreResourceAccess = "read_only"` - `Description string` Description of the memory store, snapshotted at attach time. Rendered into the agent's system prompt. Empty string when the store has no description. - `Instructions string` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `MountPath string` Filesystem path where the store is mounted in the session container, e.g. /mnt/memory/user-preferences. Derived from the store's name. Output-only. - `Name string` Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. - `Stats BetaManagedAgentsSessionStats` Timing statistics for a session. - `ActiveSeconds float64` Cumulative time in seconds the session spent in running status. Excludes idle time. - `DurationSeconds float64` Elapsed time since session creation in seconds. For terminated sessions, frozen at the final update. - `Status BetaManagedAgentsSessionStatus` SessionStatus enum - `const BetaManagedAgentsSessionStatusRescheduling BetaManagedAgentsSessionStatus = "rescheduling"` - `const BetaManagedAgentsSessionStatusRunning BetaManagedAgentsSessionStatus = "running"` - `const BetaManagedAgentsSessionStatusIdle BetaManagedAgentsSessionStatus = "idle"` - `const BetaManagedAgentsSessionStatusTerminated BetaManagedAgentsSessionStatus = "terminated"` - `Title string` - `Type BetaManagedAgentsSessionType` - `const BetaManagedAgentsSessionTypeSession BetaManagedAgentsSessionType = "session"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `Usage BetaManagedAgentsSessionUsage` Cumulative token usage for a session across all turns. - `CacheCreation BetaManagedAgentsCacheCreationUsage` Prompt-cache creation token usage broken down by cache lifetime. - `Ephemeral1hInputTokens int64` Tokens used to create 1-hour ephemeral cache entries. - `Ephemeral5mInputTokens int64` Tokens used to create 5-minute ephemeral cache entries. - `CacheReadInputTokens int64` Total tokens read from prompt cache. - `InputTokens int64` Total input tokens consumed across all turns. - `OutputTokens int64` Total output tokens generated across all turns. - `VaultIDs []string` Vault IDs attached to the session at creation. Empty when no vaults were supplied. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsSession, err := client.Beta.Sessions.Archive( context.TODO(), "sesn_011CZkZAtmR3yMPDzynEDxu7", anthropic.BetaSessionArchiveParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsSession.ID) } ``` #### Response ```json { "id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "name": "Researcher", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" } ], "system": "You are a research subagent that gathers and summarises sources for the coordinating agent.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "metadata": {}, "outcome_evaluations": [ { "completed_at": "2026-03-15T10:02:31Z", "description": "Produce a 2-page summary as summary.md", "explanation": "All five sections present with inline citations.", "iteration": 0, "outcome_id": "outc_011CZkZRSw2kEfs6ncTVljxP", "result": "satisfied", "type": "outcome_evaluation" } ], "resources": [ { "id": "sesrsc_011CZkZBJq5dWxk9fVLNcPht", "created_at": "2026-03-15T10:00:00Z", "file_id": "file_011CNha8iCJcU1wXNR6q4V8w", "mount_path": "/uploads/receipt.pdf", "type": "file", "updated_at": "2026-03-15T10:00:00Z" }, { "id": "sesrsc_011CZkZCKr6eXyl0gWMOdQiu", "created_at": "2026-03-15T10:00:00Z", "mount_path": "/workspace/example-repo", "type": "github_repository", "updated_at": "2026-03-15T10:00:00Z", "url": "https://github.com/example-org/example-repo", "checkout": { "name": "main", "type": "branch" } } ], "stats": { "active_seconds": 0, "duration_seconds": 0 }, "status": "idle", "title": "Order #1234 inquiry", "type": "session", "updated_at": "2026-03-15T10:00:00Z", "usage": { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0 }, "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ] } ``` ## Domain Types ### Beta Managed Agents Agent Params - `type BetaManagedAgentsAgentParamsResp struct{…}` Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version - `ID string` The `agent` ID. - `Type BetaManagedAgentsAgentParamsType` - `const BetaManagedAgentsAgentParamsTypeAgent BetaManagedAgentsAgentParamsType = "agent"` - `Version int64` The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified. ### Beta Managed Agents Branch Checkout - `type BetaManagedAgentsBranchCheckout struct{…}` - `Name string` Branch name to check out. - `Type BetaManagedAgentsBranchCheckoutType` - `const BetaManagedAgentsBranchCheckoutTypeBranch BetaManagedAgentsBranchCheckoutType = "branch"` ### Beta Managed Agents Cache Creation Usage - `type BetaManagedAgentsCacheCreationUsage struct{…}` Prompt-cache creation token usage broken down by cache lifetime. - `Ephemeral1hInputTokens int64` Tokens used to create 1-hour ephemeral cache entries. - `Ephemeral5mInputTokens int64` Tokens used to create 5-minute ephemeral cache entries. ### Beta Managed Agents Commit Checkout - `type BetaManagedAgentsCommitCheckout struct{…}` - `Sha string` Full commit SHA to check out. - `Type BetaManagedAgentsCommitCheckoutType` - `const BetaManagedAgentsCommitCheckoutTypeCommit BetaManagedAgentsCommitCheckoutType = "commit"` ### Beta Managed Agents Deleted Session - `type BetaManagedAgentsDeletedSession struct{…}` Confirmation that a `session` has been permanently deleted. - `ID string` - `Type BetaManagedAgentsDeletedSessionType` - `const BetaManagedAgentsDeletedSessionTypeSessionDeleted BetaManagedAgentsDeletedSessionType = "session_deleted"` ### Beta Managed Agents File Resource Params - `type BetaManagedAgentsFileResourceParamsResp struct{…}` Mount a file uploaded via the Files API into the session. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileResourceParamsType` - `const BetaManagedAgentsFileResourceParamsTypeFile BetaManagedAgentsFileResourceParamsType = "file"` - `MountPath string` Mount path in the container. Defaults to `/mnt/session/uploads/`. ### Beta Managed Agents GitHub Repository Resource Params - `type BetaManagedAgentsGitHubRepositoryResourceParamsResp struct{…}` Mount a GitHub repository into the session's container. - `AuthorizationToken string` GitHub authorization token used to clone the repository. - `Type BetaManagedAgentsGitHubRepositoryResourceParamsType` - `const BetaManagedAgentsGitHubRepositoryResourceParamsTypeGitHubRepository BetaManagedAgentsGitHubRepositoryResourceParamsType = "github_repository"` - `URL string` Github URL of the repository - `Checkout BetaManagedAgentsGitHubRepositoryResourceParamsCheckoutUnionResp` Branch or commit to check out. Defaults to the repository's default branch. - `type BetaManagedAgentsBranchCheckout struct{…}` - `Name string` Branch name to check out. - `Type BetaManagedAgentsBranchCheckoutType` - `const BetaManagedAgentsBranchCheckoutTypeBranch BetaManagedAgentsBranchCheckoutType = "branch"` - `type BetaManagedAgentsCommitCheckout struct{…}` - `Sha string` Full commit SHA to check out. - `Type BetaManagedAgentsCommitCheckoutType` - `const BetaManagedAgentsCommitCheckoutTypeCommit BetaManagedAgentsCommitCheckoutType = "commit"` - `MountPath string` Mount path in the container. Defaults to `/workspace/`. ### Beta Managed Agents Memory Store Resource Param - `type BetaManagedAgentsMemoryStoreResourceParamResp struct{…}` Parameters for attaching a memory store to an agent session. - `MemoryStoreID string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `Type BetaManagedAgentsMemoryStoreResourceParamType` - `const BetaManagedAgentsMemoryStoreResourceParamTypeMemoryStore BetaManagedAgentsMemoryStoreResourceParamType = "memory_store"` - `Access BetaManagedAgentsMemoryStoreResourceParamAccess` Access mode for an attached memory store. - `const BetaManagedAgentsMemoryStoreResourceParamAccessReadWrite BetaManagedAgentsMemoryStoreResourceParamAccess = "read_write"` - `const BetaManagedAgentsMemoryStoreResourceParamAccessReadOnly BetaManagedAgentsMemoryStoreResourceParamAccess = "read_only"` - `Instructions string` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. ### Beta Managed Agents Multiagent - `type BetaManagedAgentsMultiagent struct{…}` Resolved coordinator topology with a concrete agent roster. - `Agents []BetaManagedAgentsAgentReference` Agents the coordinator may spawn as session threads, each resolved to a specific version. - `ID string` - `Type BetaManagedAgentsAgentReferenceType` - `const BetaManagedAgentsAgentReferenceTypeAgent BetaManagedAgentsAgentReferenceType = "agent"` - `Version int64` - `Type BetaManagedAgentsMultiagentType` - `const BetaManagedAgentsMultiagentTypeCoordinator BetaManagedAgentsMultiagentType = "coordinator"` ### Beta Managed Agents Multiagent Params - `type BetaManagedAgentsMultiagentParamsResp struct{…}` A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the `agents` roster. - `Agents []BetaManagedAgentsMultiagentRosterEntryParamsUnionResp` Agents the coordinator may spawn as session threads. 1–20 entries. Each entry is an agent ID string, a versioned `{"type":"agent","id","version"}` reference, or `{"type":"self"}` to allow recursive self-invocation. Entries must reference distinct agents (after resolving `self` and string forms); at most one `self`. Referenced agents must exist, must not be archived, and must not themselves have `multiagent` set (depth limit 1). - `string` - `type BetaManagedAgentsAgentParamsResp struct{…}` Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version - `ID string` The `agent` ID. - `Type BetaManagedAgentsAgentParamsType` - `const BetaManagedAgentsAgentParamsTypeAgent BetaManagedAgentsAgentParamsType = "agent"` - `Version int64` The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified. - `type BetaManagedAgentsMultiagentSelfParamsResp struct{…}` Sentinel roster entry meaning "the agent that owns this configuration". Resolved server-side to a concrete agent reference. - `Type BetaManagedAgentsMultiagentSelfParamsType` - `const BetaManagedAgentsMultiagentSelfParamsTypeSelf BetaManagedAgentsMultiagentSelfParamsType = "self"` - `Type BetaManagedAgentsMultiagentParamsType` - `const BetaManagedAgentsMultiagentParamsTypeCoordinator BetaManagedAgentsMultiagentParamsType = "coordinator"` ### Beta Managed Agents Multiagent Roster Entry Params - `type BetaManagedAgentsMultiagentRosterEntryParamsUnionResp interface{…}` An entry in a multiagent roster: an agent ID string, a versioned agent reference, or `self`. - `string` - `type BetaManagedAgentsAgentParamsResp struct{…}` Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version - `ID string` The `agent` ID. - `Type BetaManagedAgentsAgentParamsType` - `const BetaManagedAgentsAgentParamsTypeAgent BetaManagedAgentsAgentParamsType = "agent"` - `Version int64` The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified. - `type BetaManagedAgentsMultiagentSelfParamsResp struct{…}` Sentinel roster entry meaning "the agent that owns this configuration". Resolved server-side to a concrete agent reference. - `Type BetaManagedAgentsMultiagentSelfParamsType` - `const BetaManagedAgentsMultiagentSelfParamsTypeSelf BetaManagedAgentsMultiagentSelfParamsType = "self"` ### Beta Managed Agents Outcome Evaluation Resource - `type BetaManagedAgentsOutcomeEvaluationResource struct{…}` Evaluation state for a single outcome defined via a define_outcome event. - `CompletedAt Time` A timestamp in RFC 3339 format - `Description string` What the agent should produce. - `Explanation string` Grader's verdict text from the most recent evaluation. For satisfied, explains why criteria are met; for needs_revision (intermediate), what's missing; for failed, why unrecoverable. - `Iteration int64` 0-indexed revision cycle the outcome is currently on. - `OutcomeID string` Server-generated outc_ ID for this outcome. - `Result string` Current evaluation state. `pending` before the agent begins work; `running` while producing or revising; `evaluating` while the grader scores; `satisfied`/`max_iterations_reached`/`failed`/`interrupted` are terminal. - `Type BetaManagedAgentsOutcomeEvaluationResourceType` - `const BetaManagedAgentsOutcomeEvaluationResourceTypeOutcomeEvaluation BetaManagedAgentsOutcomeEvaluationResourceType = "outcome_evaluation"` ### Beta Managed Agents Session - `type BetaManagedAgentsSession struct{…}` A Managed Agents `session`. - `ID string` - `Agent BetaManagedAgentsSessionAgent` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Multiagent BetaManagedAgentsSessionMultiagentCoordinator` Resolved coordinator topology with full agent definitions for each roster member. - `Agents []BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `Name string` - `Skills []BetaManagedAgentsSessionThreadAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsSessionThreadAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsSessionThreadAgentType` - `const BetaManagedAgentsSessionThreadAgentTypeAgent BetaManagedAgentsSessionThreadAgentType = "agent"` - `Version int64` - `Type BetaManagedAgentsSessionMultiagentCoordinatorType` - `const BetaManagedAgentsSessionMultiagentCoordinatorTypeCoordinator BetaManagedAgentsSessionMultiagentCoordinatorType = "coordinator"` - `Name string` - `Skills []BetaManagedAgentsSessionAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `System string` - `Tools []BetaManagedAgentsSessionAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `type BetaManagedAgentsMCPToolset struct{…}` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Type BetaManagedAgentsSessionAgentType` - `const BetaManagedAgentsSessionAgentTypeAgent BetaManagedAgentsSessionAgentType = "agent"` - `Version int64` - `ArchivedAt Time` A timestamp in RFC 3339 format - `CreatedAt Time` A timestamp in RFC 3339 format - `EnvironmentID string` - `Metadata map[string, string]` - `OutcomeEvaluations []BetaManagedAgentsOutcomeEvaluationResource` Per-outcome evaluation state. One entry per define_outcome event sent to the session. - `CompletedAt Time` A timestamp in RFC 3339 format - `Description string` What the agent should produce. - `Explanation string` Grader's verdict text from the most recent evaluation. For satisfied, explains why criteria are met; for needs_revision (intermediate), what's missing; for failed, why unrecoverable. - `Iteration int64` 0-indexed revision cycle the outcome is currently on. - `OutcomeID string` Server-generated outc_ ID for this outcome. - `Result string` Current evaluation state. `pending` before the agent begins work; `running` while producing or revising; `evaluating` while the grader scores; `satisfied`/`max_iterations_reached`/`failed`/`interrupted` are terminal. - `Type BetaManagedAgentsOutcomeEvaluationResourceType` - `const BetaManagedAgentsOutcomeEvaluationResourceTypeOutcomeEvaluation BetaManagedAgentsOutcomeEvaluationResourceType = "outcome_evaluation"` - `Resources []BetaManagedAgentsSessionResourceUnion` - `type BetaManagedAgentsGitHubRepositoryResource struct{…}` - `ID string` - `CreatedAt Time` A timestamp in RFC 3339 format - `MountPath string` - `Type BetaManagedAgentsGitHubRepositoryResourceType` - `const BetaManagedAgentsGitHubRepositoryResourceTypeGitHubRepository BetaManagedAgentsGitHubRepositoryResourceType = "github_repository"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `URL string` - `Checkout BetaManagedAgentsGitHubRepositoryResourceCheckoutUnion` - `type BetaManagedAgentsBranchCheckout struct{…}` - `Name string` Branch name to check out. - `Type BetaManagedAgentsBranchCheckoutType` - `const BetaManagedAgentsBranchCheckoutTypeBranch BetaManagedAgentsBranchCheckoutType = "branch"` - `type BetaManagedAgentsCommitCheckout struct{…}` - `Sha string` Full commit SHA to check out. - `Type BetaManagedAgentsCommitCheckoutType` - `const BetaManagedAgentsCommitCheckoutTypeCommit BetaManagedAgentsCommitCheckoutType = "commit"` - `type BetaManagedAgentsFileResource struct{…}` - `ID string` - `CreatedAt Time` A timestamp in RFC 3339 format - `FileID string` - `MountPath string` - `Type BetaManagedAgentsFileResourceType` - `const BetaManagedAgentsFileResourceTypeFile BetaManagedAgentsFileResourceType = "file"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `type BetaManagedAgentsMemoryStoreResource struct{…}` A memory store attached to an agent session. - `MemoryStoreID string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `Type BetaManagedAgentsMemoryStoreResourceType` - `const BetaManagedAgentsMemoryStoreResourceTypeMemoryStore BetaManagedAgentsMemoryStoreResourceType = "memory_store"` - `Access BetaManagedAgentsMemoryStoreResourceAccess` Access mode for an attached memory store. - `const BetaManagedAgentsMemoryStoreResourceAccessReadWrite BetaManagedAgentsMemoryStoreResourceAccess = "read_write"` - `const BetaManagedAgentsMemoryStoreResourceAccessReadOnly BetaManagedAgentsMemoryStoreResourceAccess = "read_only"` - `Description string` Description of the memory store, snapshotted at attach time. Rendered into the agent's system prompt. Empty string when the store has no description. - `Instructions string` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `MountPath string` Filesystem path where the store is mounted in the session container, e.g. /mnt/memory/user-preferences. Derived from the store's name. Output-only. - `Name string` Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. - `Stats BetaManagedAgentsSessionStats` Timing statistics for a session. - `ActiveSeconds float64` Cumulative time in seconds the session spent in running status. Excludes idle time. - `DurationSeconds float64` Elapsed time since session creation in seconds. For terminated sessions, frozen at the final update. - `Status BetaManagedAgentsSessionStatus` SessionStatus enum - `const BetaManagedAgentsSessionStatusRescheduling BetaManagedAgentsSessionStatus = "rescheduling"` - `const BetaManagedAgentsSessionStatusRunning BetaManagedAgentsSessionStatus = "running"` - `const BetaManagedAgentsSessionStatusIdle BetaManagedAgentsSessionStatus = "idle"` - `const BetaManagedAgentsSessionStatusTerminated BetaManagedAgentsSessionStatus = "terminated"` - `Title string` - `Type BetaManagedAgentsSessionType` - `const BetaManagedAgentsSessionTypeSession BetaManagedAgentsSessionType = "session"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `Usage BetaManagedAgentsSessionUsage` Cumulative token usage for a session across all turns. - `CacheCreation BetaManagedAgentsCacheCreationUsage` Prompt-cache creation token usage broken down by cache lifetime. - `Ephemeral1hInputTokens int64` Tokens used to create 1-hour ephemeral cache entries. - `Ephemeral5mInputTokens int64` Tokens used to create 5-minute ephemeral cache entries. - `CacheReadInputTokens int64` Total tokens read from prompt cache. - `InputTokens int64` Total input tokens consumed across all turns. - `OutputTokens int64` Total output tokens generated across all turns. - `VaultIDs []string` Vault IDs attached to the session at creation. Empty when no vaults were supplied. ### Beta Managed Agents Session Agent - `type BetaManagedAgentsSessionAgent struct{…}` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Multiagent BetaManagedAgentsSessionMultiagentCoordinator` Resolved coordinator topology with full agent definitions for each roster member. - `Agents []BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `Name string` - `Skills []BetaManagedAgentsSessionThreadAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsSessionThreadAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsSessionThreadAgentType` - `const BetaManagedAgentsSessionThreadAgentTypeAgent BetaManagedAgentsSessionThreadAgentType = "agent"` - `Version int64` - `Type BetaManagedAgentsSessionMultiagentCoordinatorType` - `const BetaManagedAgentsSessionMultiagentCoordinatorTypeCoordinator BetaManagedAgentsSessionMultiagentCoordinatorType = "coordinator"` - `Name string` - `Skills []BetaManagedAgentsSessionAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `System string` - `Tools []BetaManagedAgentsSessionAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `type BetaManagedAgentsMCPToolset struct{…}` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Type BetaManagedAgentsSessionAgentType` - `const BetaManagedAgentsSessionAgentTypeAgent BetaManagedAgentsSessionAgentType = "agent"` - `Version int64` ### Beta Managed Agents Session Agent Update - `type BetaManagedAgentsSessionAgentUpdate struct{…}` Mid-session agent configuration update. Only `tools` and `mcp_servers` are updatable. Full replacement: the provided array becomes the new value. To preserve existing entries, GET the session, modify the array, and POST it back. - `MCPServers []BetaManagedAgentsURLMCPServerParamsResp` Replacement MCP server list. Full replacement: the provided array becomes the new value. Send an empty array to clear; omit to preserve. - `Name string` Unique name for this server, referenced by mcp_toolset configurations. 1-255 characters. - `Type BetaManagedAgentsURLMCPServerParamsType` - `const BetaManagedAgentsURLMCPServerParamsTypeURL BetaManagedAgentsURLMCPServerParamsType = "url"` - `URL string` Endpoint URL for the MCP server. - `Tools []BetaManagedAgentsSessionAgentUpdateToolUnion` Replacement tool list. Full replacement: the provided array becomes the new value. Send an empty array to clear; omit to preserve. - `type BetaManagedAgentsAgentToolset20260401ParamsResp struct{…}` Configuration for built-in agent tools. Use this to enable or disable groups of tools available to the agent. - `Type BetaManagedAgentsAgentToolset20260401ParamsType` - `const BetaManagedAgentsAgentToolset20260401ParamsTypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401ParamsType = "agent_toolset_20260401"` - `Configs []BetaManagedAgentsAgentToolConfigParamsResp` Per-tool configuration overrides. - `Name BetaManagedAgentsAgentToolConfigParamsName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigParamsNameBash BetaManagedAgentsAgentToolConfigParamsName = "bash"` - `const BetaManagedAgentsAgentToolConfigParamsNameEdit BetaManagedAgentsAgentToolConfigParamsName = "edit"` - `const BetaManagedAgentsAgentToolConfigParamsNameRead BetaManagedAgentsAgentToolConfigParamsName = "read"` - `const BetaManagedAgentsAgentToolConfigParamsNameWrite BetaManagedAgentsAgentToolConfigParamsName = "write"` - `const BetaManagedAgentsAgentToolConfigParamsNameGlob BetaManagedAgentsAgentToolConfigParamsName = "glob"` - `const BetaManagedAgentsAgentToolConfigParamsNameGrep BetaManagedAgentsAgentToolConfigParamsName = "grep"` - `const BetaManagedAgentsAgentToolConfigParamsNameWebFetch BetaManagedAgentsAgentToolConfigParamsName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigParamsNameWebSearch BetaManagedAgentsAgentToolConfigParamsName = "web_search"` - `Enabled bool` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `PermissionPolicy BetaManagedAgentsAgentToolConfigParamsPermissionPolicyUnionResp` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfigParamsResp` Default configuration for all tools in a toolset. - `Enabled bool` Whether tools are enabled and available to Claude by default. Defaults to true if not specified. - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigParamsPermissionPolicyUnionResp` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `type BetaManagedAgentsMCPToolsetParamsResp struct{…}` Configuration for tools from an MCP server defined in `mcp_servers`. - `MCPServerName string` Name of the MCP server. Must match a server name from the mcp_servers array. 1-255 characters. - `Type BetaManagedAgentsMCPToolsetParamsType` - `const BetaManagedAgentsMCPToolsetParamsTypeMCPToolset BetaManagedAgentsMCPToolsetParamsType = "mcp_toolset"` - `Configs []BetaManagedAgentsMCPToolConfigParamsResp` Per-tool configuration overrides. - `Name string` Name of the MCP tool to configure. 1-128 characters. - `Enabled bool` Whether this tool is enabled. Overrides the `default_config` setting. - `PermissionPolicy BetaManagedAgentsMCPToolConfigParamsPermissionPolicyUnionResp` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfigParamsResp` Default configuration for all tools from an MCP server. - `Enabled bool` Whether tools are enabled by default. Defaults to true if not specified. - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigParamsPermissionPolicyUnionResp` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `type BetaManagedAgentsCustomToolParamsResp struct{…}` A custom tool that is executed by the API client rather than the agent. When the agent calls this tool, an `agent.custom_tool_use` event is emitted and the session goes idle, waiting for the client to provide the result via a `user.custom_tool_result` event. - `Description string` Description of what the tool does, shown to the agent to help it decide when to use the tool. 1-1024 characters. - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` Unique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens. - `Type BetaManagedAgentsCustomToolParamsType` - `const BetaManagedAgentsCustomToolParamsTypeCustom BetaManagedAgentsCustomToolParamsType = "custom"` ### Beta Managed Agents Session Multiagent Coordinator - `type BetaManagedAgentsSessionMultiagentCoordinator struct{…}` Resolved coordinator topology with full agent definitions for each roster member. - `Agents []BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Name string` - `Skills []BetaManagedAgentsSessionThreadAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsSessionThreadAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsSessionThreadAgentType` - `const BetaManagedAgentsSessionThreadAgentTypeAgent BetaManagedAgentsSessionThreadAgentType = "agent"` - `Version int64` - `Type BetaManagedAgentsSessionMultiagentCoordinatorType` - `const BetaManagedAgentsSessionMultiagentCoordinatorTypeCoordinator BetaManagedAgentsSessionMultiagentCoordinatorType = "coordinator"` ### Beta Managed Agents Session Stats - `type BetaManagedAgentsSessionStats struct{…}` Timing statistics for a session. - `ActiveSeconds float64` Cumulative time in seconds the session spent in running status. Excludes idle time. - `DurationSeconds float64` Elapsed time since session creation in seconds. For terminated sessions, frozen at the final update. ### Beta Managed Agents Session Updated Event - `type BetaManagedAgentsSessionUpdatedEvent struct{…}` Emitted when an UpdateSession request changed at least one field. Carries only the fields that changed; absent fields were not part of the update. The new configuration applies from the next turn. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionUpdatedEventType` - `const BetaManagedAgentsSessionUpdatedEventTypeSessionUpdated BetaManagedAgentsSessionUpdatedEventType = "session.updated"` - `Agent BetaManagedAgentsSessionAgent` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Multiagent BetaManagedAgentsSessionMultiagentCoordinator` Resolved coordinator topology with full agent definitions for each roster member. - `Agents []BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `Name string` - `Skills []BetaManagedAgentsSessionThreadAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsSessionThreadAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsSessionThreadAgentType` - `const BetaManagedAgentsSessionThreadAgentTypeAgent BetaManagedAgentsSessionThreadAgentType = "agent"` - `Version int64` - `Type BetaManagedAgentsSessionMultiagentCoordinatorType` - `const BetaManagedAgentsSessionMultiagentCoordinatorTypeCoordinator BetaManagedAgentsSessionMultiagentCoordinatorType = "coordinator"` - `Name string` - `Skills []BetaManagedAgentsSessionAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `System string` - `Tools []BetaManagedAgentsSessionAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `type BetaManagedAgentsMCPToolset struct{…}` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Type BetaManagedAgentsSessionAgentType` - `const BetaManagedAgentsSessionAgentTypeAgent BetaManagedAgentsSessionAgentType = "agent"` - `Version int64` - `Metadata map[string, string]` The session's full metadata bag after the update. Present when the update set non-empty metadata; absent when metadata was unchanged or cleared to empty. - `Title string` The session's new title. Present only when the update changed it. ### Beta Managed Agents Session Usage - `type BetaManagedAgentsSessionUsage struct{…}` Cumulative token usage for a session across all turns. - `CacheCreation BetaManagedAgentsCacheCreationUsage` Prompt-cache creation token usage broken down by cache lifetime. - `Ephemeral1hInputTokens int64` Tokens used to create 1-hour ephemeral cache entries. - `Ephemeral5mInputTokens int64` Tokens used to create 5-minute ephemeral cache entries. - `CacheReadInputTokens int64` Total tokens read from prompt cache. - `InputTokens int64` Total input tokens consumed across all turns. - `OutputTokens int64` Total output tokens generated across all turns. ### Beta Managed Agents User Tool Result Event - `type BetaManagedAgentsUserToolResultEvent struct{…}` Event sent by the client providing the result of an agent-toolset tool execution. Only valid on `self_hosted` environments, where sandbox-routed tools are executed by the client rather than the server. - `ID string` Unique identifier for this event. - `ToolUseID string` The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserToolResultEventType` - `const BetaManagedAgentsUserToolResultEventTypeUserToolResult BetaManagedAgentsUserToolResultEventType = "user.tool_result"` - `Content []BetaManagedAgentsUserToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `const BetaManagedAgentsTextBlockTypeText BetaManagedAgentsTextBlockType = "text"` - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `Source BetaManagedAgentsImageBlockSourceUnion` Union type for image source variants. - `type BetaManagedAgentsBase64ImageSource struct{…}` Base64-encoded image data. - `Data string` Base64-encoded image data. - `MediaType string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `Type BetaManagedAgentsBase64ImageSourceType` - `const BetaManagedAgentsBase64ImageSourceTypeBase64 BetaManagedAgentsBase64ImageSourceType = "base64"` - `type BetaManagedAgentsURLImageSource struct{…}` Image referenced by URL. - `Type BetaManagedAgentsURLImageSourceType` - `const BetaManagedAgentsURLImageSourceTypeURL BetaManagedAgentsURLImageSourceType = "url"` - `URL string` URL of the image to fetch. - `type BetaManagedAgentsFileImageSource struct{…}` Image referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileImageSourceType` - `const BetaManagedAgentsFileImageSourceTypeFile BetaManagedAgentsFileImageSourceType = "file"` - `Type BetaManagedAgentsImageBlockType` - `const BetaManagedAgentsImageBlockTypeImage BetaManagedAgentsImageBlockType = "image"` - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `Source BetaManagedAgentsDocumentBlockSourceUnion` Union type for document source variants. - `type BetaManagedAgentsBase64DocumentSource struct{…}` Base64-encoded document data. - `Data string` Base64-encoded document data. - `MediaType string` MIME type of the document (e.g., "application/pdf"). - `Type BetaManagedAgentsBase64DocumentSourceType` - `const BetaManagedAgentsBase64DocumentSourceTypeBase64 BetaManagedAgentsBase64DocumentSourceType = "base64"` - `type BetaManagedAgentsPlainTextDocumentSource struct{…}` Plain text document content. - `Data string` The plain text content. - `MediaType BetaManagedAgentsPlainTextDocumentSourceMediaType` MIME type of the text content. Must be "text/plain". - `const BetaManagedAgentsPlainTextDocumentSourceMediaTypeTextPlain BetaManagedAgentsPlainTextDocumentSourceMediaType = "text/plain"` - `Type BetaManagedAgentsPlainTextDocumentSourceType` - `const BetaManagedAgentsPlainTextDocumentSourceTypeText BetaManagedAgentsPlainTextDocumentSourceType = "text"` - `type BetaManagedAgentsURLDocumentSource struct{…}` Document referenced by URL. - `Type BetaManagedAgentsURLDocumentSourceType` - `const BetaManagedAgentsURLDocumentSourceTypeURL BetaManagedAgentsURLDocumentSourceType = "url"` - `URL string` URL of the document to fetch. - `type BetaManagedAgentsFileDocumentSource struct{…}` Document referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileDocumentSourceType` - `const BetaManagedAgentsFileDocumentSourceTypeFile BetaManagedAgentsFileDocumentSourceType = "file"` - `Type BetaManagedAgentsDocumentBlockType` - `const BetaManagedAgentsDocumentBlockTypeDocument BetaManagedAgentsDocumentBlockType = "document"` - `Context string` Additional context about the document for the model. - `Title string` The title of the document. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `Citations BetaManagedAgentsSearchResultCitations` Citation settings for a search result. - `Enabled bool` Whether citations are enabled for this search result. - `Content []BetaManagedAgentsSearchResultContent` Array of text content blocks from the search result. - `Text string` The text content. - `Type BetaManagedAgentsSearchResultContentType` - `const BetaManagedAgentsSearchResultContentTypeText BetaManagedAgentsSearchResultContentType = "text"` - `Source string` The URL source of the search result. - `Title string` The title of the search result. - `Type BetaManagedAgentsSearchResultBlockType` - `const BetaManagedAgentsSearchResultBlockTypeSearchResult BetaManagedAgentsSearchResultBlockType = "search_result"` - `IsError bool` Whether the tool execution resulted in an error. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Routes this result to a subagent thread. Copy from the `agent.tool_use` event's `session_thread_id`. # Events ## List Events `client.Beta.Sessions.Events.List(ctx, sessionID, params) (*PageCursor[BetaManagedAgentsSessionEventUnion], error)` **get** `/v1/sessions/{session_id}/events` List Events ### Parameters - `sessionID string` - `params BetaSessionEventListParams` - `CreatedAtGt param.Field[Time]` Query param: Return events created after this time (exclusive). - `CreatedAtGte param.Field[Time]` Query param: Return events created at or after this time (inclusive). - `CreatedAtLt param.Field[Time]` Query param: Return events created before this time (exclusive). - `CreatedAtLte param.Field[Time]` Query param: Return events created at or before this time (inclusive). - `Limit param.Field[int64]` Query param: Query parameter for limit - `Order param.Field[BetaSessionEventListParamsOrder]` Query param: Sort direction for results, ordered by created_at. Defaults to asc (chronological). - `const BetaSessionEventListParamsOrderAsc BetaSessionEventListParamsOrder = "asc"` - `const BetaSessionEventListParamsOrderDesc BetaSessionEventListParamsOrder = "desc"` - `Page param.Field[string]` Query param: Opaque pagination cursor from a previous response's next_page. - `Types param.Field[[]string]` Query param: Filter by event type. Values match the `type` field on returned events (for example, `user.message` or `agent.tool_use`). Omit to return all event types. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsSessionEventUnion interface{…}` Union type for all event types in a session. - `type BetaManagedAgentsUserMessageEvent struct{…}` A user message event in the session conversation. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsUserMessageEventContentUnion` Array of content blocks comprising the user message. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `const BetaManagedAgentsTextBlockTypeText BetaManagedAgentsTextBlockType = "text"` - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `Source BetaManagedAgentsImageBlockSourceUnion` Union type for image source variants. - `type BetaManagedAgentsBase64ImageSource struct{…}` Base64-encoded image data. - `Data string` Base64-encoded image data. - `MediaType string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `Type BetaManagedAgentsBase64ImageSourceType` - `const BetaManagedAgentsBase64ImageSourceTypeBase64 BetaManagedAgentsBase64ImageSourceType = "base64"` - `type BetaManagedAgentsURLImageSource struct{…}` Image referenced by URL. - `Type BetaManagedAgentsURLImageSourceType` - `const BetaManagedAgentsURLImageSourceTypeURL BetaManagedAgentsURLImageSourceType = "url"` - `URL string` URL of the image to fetch. - `type BetaManagedAgentsFileImageSource struct{…}` Image referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileImageSourceType` - `const BetaManagedAgentsFileImageSourceTypeFile BetaManagedAgentsFileImageSourceType = "file"` - `Type BetaManagedAgentsImageBlockType` - `const BetaManagedAgentsImageBlockTypeImage BetaManagedAgentsImageBlockType = "image"` - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `Source BetaManagedAgentsDocumentBlockSourceUnion` Union type for document source variants. - `type BetaManagedAgentsBase64DocumentSource struct{…}` Base64-encoded document data. - `Data string` Base64-encoded document data. - `MediaType string` MIME type of the document (e.g., "application/pdf"). - `Type BetaManagedAgentsBase64DocumentSourceType` - `const BetaManagedAgentsBase64DocumentSourceTypeBase64 BetaManagedAgentsBase64DocumentSourceType = "base64"` - `type BetaManagedAgentsPlainTextDocumentSource struct{…}` Plain text document content. - `Data string` The plain text content. - `MediaType BetaManagedAgentsPlainTextDocumentSourceMediaType` MIME type of the text content. Must be "text/plain". - `const BetaManagedAgentsPlainTextDocumentSourceMediaTypeTextPlain BetaManagedAgentsPlainTextDocumentSourceMediaType = "text/plain"` - `Type BetaManagedAgentsPlainTextDocumentSourceType` - `const BetaManagedAgentsPlainTextDocumentSourceTypeText BetaManagedAgentsPlainTextDocumentSourceType = "text"` - `type BetaManagedAgentsURLDocumentSource struct{…}` Document referenced by URL. - `Type BetaManagedAgentsURLDocumentSourceType` - `const BetaManagedAgentsURLDocumentSourceTypeURL BetaManagedAgentsURLDocumentSourceType = "url"` - `URL string` URL of the document to fetch. - `type BetaManagedAgentsFileDocumentSource struct{…}` Document referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileDocumentSourceType` - `const BetaManagedAgentsFileDocumentSourceTypeFile BetaManagedAgentsFileDocumentSourceType = "file"` - `Type BetaManagedAgentsDocumentBlockType` - `const BetaManagedAgentsDocumentBlockTypeDocument BetaManagedAgentsDocumentBlockType = "document"` - `Context string` Additional context about the document for the model. - `Title string` The title of the document. - `Type BetaManagedAgentsUserMessageEventType` - `const BetaManagedAgentsUserMessageEventTypeUserMessage BetaManagedAgentsUserMessageEventType = "user.message"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `type BetaManagedAgentsUserInterruptEvent struct{…}` An interrupt event that pauses agent execution and returns control to the user. - `ID string` Unique identifier for this event. - `Type BetaManagedAgentsUserInterruptEventType` - `const BetaManagedAgentsUserInterruptEventTypeUserInterrupt BetaManagedAgentsUserInterruptEventType = "user.interrupt"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. - `type BetaManagedAgentsUserToolConfirmationEvent struct{…}` A tool confirmation event that approves or denies a pending tool execution. - `ID string` Unique identifier for this event. - `Result BetaManagedAgentsUserToolConfirmationEventResult` UserToolConfirmationResult enum - `const BetaManagedAgentsUserToolConfirmationEventResultAllow BetaManagedAgentsUserToolConfirmationEventResult = "allow"` - `const BetaManagedAgentsUserToolConfirmationEventResultDeny BetaManagedAgentsUserToolConfirmationEventResult = "deny"` - `ToolUseID string` The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserToolConfirmationEventType` - `const BetaManagedAgentsUserToolConfirmationEventTypeUserToolConfirmation BetaManagedAgentsUserToolConfirmationEventType = "user.tool_confirmation"` - `DenyMessage string` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` When set, the confirmation routes to this subagent's thread rather than the primary. Echo this from the `session_thread_id` on the `agent.tool_use` or `agent.mcp_tool_use` event that prompted the approval. - `type BetaManagedAgentsUserCustomToolResultEvent struct{…}` Event sent by the client providing the result of a custom tool execution. - `ID string` Unique identifier for this event. - `CustomToolUseID string` The id of the `agent.custom_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserCustomToolResultEventType` - `const BetaManagedAgentsUserCustomToolResultEventTypeUserCustomToolResult BetaManagedAgentsUserCustomToolResultEventType = "user.custom_tool_result"` - `Content []BetaManagedAgentsUserCustomToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `Citations BetaManagedAgentsSearchResultCitations` Citation settings for a search result. - `Enabled bool` Whether citations are enabled for this search result. - `Content []BetaManagedAgentsSearchResultContent` Array of text content blocks from the search result. - `Text string` The text content. - `Type BetaManagedAgentsSearchResultContentType` - `const BetaManagedAgentsSearchResultContentTypeText BetaManagedAgentsSearchResultContentType = "text"` - `Source string` The URL source of the search result. - `Title string` The title of the search result. - `Type BetaManagedAgentsSearchResultBlockType` - `const BetaManagedAgentsSearchResultBlockTypeSearchResult BetaManagedAgentsSearchResultBlockType = "search_result"` - `IsError bool` Whether the tool execution resulted in an error. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Routes this result to a subagent thread. Copy from the `agent.custom_tool_use` event's `session_thread_id`. - `type BetaManagedAgentsAgentCustomToolUseEvent struct{…}` Event emitted when the agent calls a custom tool. The session goes idle until the client sends a `user.custom_tool_result` event with the result. - `ID string` Unique identifier for this event. - `Input map[string, any]` Input parameters for the tool call. - `Name string` Name of the custom tool being called. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentCustomToolUseEventType` - `const BetaManagedAgentsAgentCustomToolUseEventTypeAgentCustomToolUse BetaManagedAgentsAgentCustomToolUseEventType = "agent.custom_tool_use"` - `SessionThreadID string` When set, this event was cross-posted from a subagent's thread to surface its custom tool use on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.custom_tool_result` event to route the result back. - `type BetaManagedAgentsAgentMessageEvent struct{…}` An agent response event in the session conversation. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsTextBlock` Array of text blocks comprising the agent response. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentMessageEventType` - `const BetaManagedAgentsAgentMessageEventTypeAgentMessage BetaManagedAgentsAgentMessageEventType = "agent.message"` - `type BetaManagedAgentsAgentThinkingEvent struct{…}` Indicates the agent is making forward progress via extended thinking. A progress signal, not a content carrier. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentThinkingEventType` - `const BetaManagedAgentsAgentThinkingEventTypeAgentThinking BetaManagedAgentsAgentThinkingEventType = "agent.thinking"` - `type BetaManagedAgentsAgentMCPToolUseEvent struct{…}` Event emitted when the agent invokes a tool provided by an MCP server. - `ID string` Unique identifier for this event. - `Input map[string, any]` Input parameters for the tool call. - `MCPServerName string` Name of the MCP server providing the tool. - `Name string` Name of the MCP tool being used. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentMCPToolUseEventType` - `const BetaManagedAgentsAgentMCPToolUseEventTypeAgentMCPToolUse BetaManagedAgentsAgentMCPToolUseEventType = "agent.mcp_tool_use"` - `EvaluatedPermission BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission` AgentEvaluatedPermission enum - `const BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermissionAllow BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission = "allow"` - `const BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermissionAsk BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission = "ask"` - `const BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermissionDeny BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission = "deny"` - `SessionThreadID string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `type BetaManagedAgentsAgentMCPToolResultEvent struct{…}` Event representing the result of an MCP tool execution. - `ID string` Unique identifier for this event. - `MCPToolUseID string` The id of the `agent.mcp_tool_use` event this result corresponds to. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentMCPToolResultEventType` - `const BetaManagedAgentsAgentMCPToolResultEventTypeAgentMCPToolResult BetaManagedAgentsAgentMCPToolResultEventType = "agent.mcp_tool_result"` - `Content []BetaManagedAgentsAgentMCPToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `IsError bool` Whether the tool execution resulted in an error. - `type BetaManagedAgentsAgentToolUseEvent struct{…}` Event emitted when the agent invokes a built-in agent tool. - `ID string` Unique identifier for this event. - `Input map[string, any]` Input parameters for the tool call. - `Name string` Name of the agent tool being used. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentToolUseEventType` - `const BetaManagedAgentsAgentToolUseEventTypeAgentToolUse BetaManagedAgentsAgentToolUseEventType = "agent.tool_use"` - `EvaluatedPermission BetaManagedAgentsAgentToolUseEventEvaluatedPermission` AgentEvaluatedPermission enum - `const BetaManagedAgentsAgentToolUseEventEvaluatedPermissionAllow BetaManagedAgentsAgentToolUseEventEvaluatedPermission = "allow"` - `const BetaManagedAgentsAgentToolUseEventEvaluatedPermissionAsk BetaManagedAgentsAgentToolUseEventEvaluatedPermission = "ask"` - `const BetaManagedAgentsAgentToolUseEventEvaluatedPermissionDeny BetaManagedAgentsAgentToolUseEventEvaluatedPermission = "deny"` - `SessionThreadID string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `type BetaManagedAgentsAgentToolResultEvent struct{…}` Event representing the result of an agent tool execution. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `ToolUseID string` The id of the `agent.tool_use` event this result corresponds to. - `Type BetaManagedAgentsAgentToolResultEventType` - `const BetaManagedAgentsAgentToolResultEventTypeAgentToolResult BetaManagedAgentsAgentToolResultEventType = "agent.tool_result"` - `Content []BetaManagedAgentsAgentToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `IsError bool` Whether the tool execution resulted in an error. - `type BetaManagedAgentsAgentThreadMessageReceivedEvent struct{…}` Delivery event written to the target thread's input stream when an agent-to-agent message arrives. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsAgentThreadMessageReceivedEventContentUnion` Message content blocks. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `FromSessionThreadID string` Public `sthr_` ID of the thread that sent the message. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentThreadMessageReceivedEventType` - `const BetaManagedAgentsAgentThreadMessageReceivedEventTypeAgentThreadMessageReceived BetaManagedAgentsAgentThreadMessageReceivedEventType = "agent.thread_message_received"` - `FromAgentName string` Name of the callable agent this message came from. Absent when received from the primary agent. - `type BetaManagedAgentsAgentThreadMessageSentEvent struct{…}` Observability event emitted to the sender's output stream when an agent-to-agent message is sent. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsAgentThreadMessageSentEventContentUnion` Message content blocks. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `ProcessedAt Time` A timestamp in RFC 3339 format - `ToSessionThreadID string` Public `sthr_` ID of the thread the message was sent to. - `Type BetaManagedAgentsAgentThreadMessageSentEventType` - `const BetaManagedAgentsAgentThreadMessageSentEventTypeAgentThreadMessageSent BetaManagedAgentsAgentThreadMessageSentEventType = "agent.thread_message_sent"` - `ToAgentName string` Name of the callable agent this message was sent to. Absent when sent to the primary agent. - `type BetaManagedAgentsAgentThreadContextCompactedEvent struct{…}` Indicates that context compaction (summarization) occurred during the session. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentThreadContextCompactedEventType` - `const BetaManagedAgentsAgentThreadContextCompactedEventTypeAgentThreadContextCompacted BetaManagedAgentsAgentThreadContextCompactedEventType = "agent.thread_context_compacted"` - `type BetaManagedAgentsSessionErrorEvent struct{…}` An error event indicating a problem occurred during session execution. - `ID string` Unique identifier for this event. - `Error BetaManagedAgentsSessionErrorEventErrorUnion` An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on `retry_status` and `message` alone. - `type BetaManagedAgentsUnknownError struct{…}` An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on `retry_status` and `message` alone. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsUnknownErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `Type BetaManagedAgentsRetryStatusRetryingType` - `const BetaManagedAgentsRetryStatusRetryingTypeRetrying BetaManagedAgentsRetryStatusRetryingType = "retrying"` - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `Type BetaManagedAgentsRetryStatusExhaustedType` - `const BetaManagedAgentsRetryStatusExhaustedTypeExhausted BetaManagedAgentsRetryStatusExhaustedType = "exhausted"` - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsRetryStatusTerminalType` - `const BetaManagedAgentsRetryStatusTerminalTypeTerminal BetaManagedAgentsRetryStatusTerminalType = "terminal"` - `Type BetaManagedAgentsUnknownErrorType` - `const BetaManagedAgentsUnknownErrorTypeUnknownError BetaManagedAgentsUnknownErrorType = "unknown_error"` - `type BetaManagedAgentsModelOverloadedError struct{…}` The model is currently overloaded. Emitted after automatic retries are exhausted. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsModelOverloadedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsModelOverloadedErrorType` - `const BetaManagedAgentsModelOverloadedErrorTypeModelOverloadedError BetaManagedAgentsModelOverloadedErrorType = "model_overloaded_error"` - `type BetaManagedAgentsModelRateLimitedError struct{…}` The model request was rate-limited. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsModelRateLimitedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsModelRateLimitedErrorType` - `const BetaManagedAgentsModelRateLimitedErrorTypeModelRateLimitedError BetaManagedAgentsModelRateLimitedErrorType = "model_rate_limited_error"` - `type BetaManagedAgentsModelRequestFailedError struct{…}` A model request failed for a reason other than overload or rate-limiting. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsModelRequestFailedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsModelRequestFailedErrorType` - `const BetaManagedAgentsModelRequestFailedErrorTypeModelRequestFailedError BetaManagedAgentsModelRequestFailedErrorType = "model_request_failed_error"` - `type BetaManagedAgentsMCPConnectionFailedError struct{…}` Failed to connect to an MCP server. - `MCPServerName string` Name of the MCP server that failed to connect. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsMCPConnectionFailedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsMCPConnectionFailedErrorType` - `const BetaManagedAgentsMCPConnectionFailedErrorTypeMCPConnectionFailedError BetaManagedAgentsMCPConnectionFailedErrorType = "mcp_connection_failed_error"` - `type BetaManagedAgentsMCPAuthenticationFailedError struct{…}` Authentication to an MCP server failed. - `MCPServerName string` Name of the MCP server that failed authentication. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsMCPAuthenticationFailedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsMCPAuthenticationFailedErrorType` - `const BetaManagedAgentsMCPAuthenticationFailedErrorTypeMCPAuthenticationFailedError BetaManagedAgentsMCPAuthenticationFailedErrorType = "mcp_authentication_failed_error"` - `type BetaManagedAgentsBillingError struct{…}` The caller's organization or workspace cannot make model requests — out of credits or spend limit reached. Retrying with the same credentials will not succeed; the caller must resolve the billing state. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsBillingErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsBillingErrorType` - `const BetaManagedAgentsBillingErrorTypeBillingError BetaManagedAgentsBillingErrorType = "billing_error"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionErrorEventType` - `const BetaManagedAgentsSessionErrorEventTypeSessionError BetaManagedAgentsSessionErrorEventType = "session.error"` - `type BetaManagedAgentsSessionStatusRescheduledEvent struct{…}` Indicates the session is recovering from an error state and is rescheduled for execution. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionStatusRescheduledEventType` - `const BetaManagedAgentsSessionStatusRescheduledEventTypeSessionStatusRescheduled BetaManagedAgentsSessionStatusRescheduledEventType = "session.status_rescheduled"` - `type BetaManagedAgentsSessionStatusRunningEvent struct{…}` Indicates the session is actively running and the agent is working. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionStatusRunningEventType` - `const BetaManagedAgentsSessionStatusRunningEventTypeSessionStatusRunning BetaManagedAgentsSessionStatusRunningEventType = "session.status_running"` - `type BetaManagedAgentsSessionStatusIdleEvent struct{…}` Indicates the agent has paused and is awaiting user input. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `StopReason BetaManagedAgentsSessionStatusIdleEventStopReasonUnion` The agent completed its turn naturally and is ready for the next user message. - `type BetaManagedAgentsSessionEndTurn struct{…}` The agent completed its turn naturally and is ready for the next user message. - `Type BetaManagedAgentsSessionEndTurnType` - `const BetaManagedAgentsSessionEndTurnTypeEndTurn BetaManagedAgentsSessionEndTurnType = "end_turn"` - `type BetaManagedAgentsSessionRequiresAction struct{…}` The agent is idle waiting on one or more blocking user-input events (tool confirmation, custom tool result, etc.). Resolving all of them transitions the session back to running. - `EventIDs []string` The ids of events the agent is blocked on. Resolving fewer than all re-emits `session.status_idle` with the remainder. - `Type BetaManagedAgentsSessionRequiresActionType` - `const BetaManagedAgentsSessionRequiresActionTypeRequiresAction BetaManagedAgentsSessionRequiresActionType = "requires_action"` - `type BetaManagedAgentsSessionRetriesExhausted struct{…}` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `Type BetaManagedAgentsSessionRetriesExhaustedType` - `const BetaManagedAgentsSessionRetriesExhaustedTypeRetriesExhausted BetaManagedAgentsSessionRetriesExhaustedType = "retries_exhausted"` - `Type BetaManagedAgentsSessionStatusIdleEventType` - `const BetaManagedAgentsSessionStatusIdleEventTypeSessionStatusIdle BetaManagedAgentsSessionStatusIdleEventType = "session.status_idle"` - `type BetaManagedAgentsSessionStatusTerminatedEvent struct{…}` Indicates the session has terminated, either due to an error or completion. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionStatusTerminatedEventType` - `const BetaManagedAgentsSessionStatusTerminatedEventTypeSessionStatusTerminated BetaManagedAgentsSessionStatusTerminatedEventType = "session.status_terminated"` - `type BetaManagedAgentsSessionThreadCreatedEvent struct{…}` Emitted when a subagent is spawned as a new thread. Written to the parent thread's output stream so clients observing the session see child creation. - `ID string` Unique identifier for this event. - `AgentName string` Name of the callable agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public `sthr_` ID of the newly created thread. - `Type BetaManagedAgentsSessionThreadCreatedEventType` - `const BetaManagedAgentsSessionThreadCreatedEventTypeSessionThreadCreated BetaManagedAgentsSessionThreadCreatedEventType = "session.thread_created"` - `type BetaManagedAgentsSpanOutcomeEvaluationStartEvent struct{…}` Emitted when an outcome evaluation cycle begins. - `ID string` Unique identifier for this event. - `Iteration int64` 0-indexed revision cycle. 0 is the first evaluation; 1 is the re-evaluation after the first revision; etc. - `OutcomeID string` The `outc_` ID of the outcome being evaluated. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanOutcomeEvaluationStartEventType` - `const BetaManagedAgentsSpanOutcomeEvaluationStartEventTypeSpanOutcomeEvaluationStart BetaManagedAgentsSpanOutcomeEvaluationStartEventType = "span.outcome_evaluation_start"` - `type BetaManagedAgentsSpanOutcomeEvaluationEndEvent struct{…}` Emitted when an outcome evaluation cycle completes. Carries the verdict and aggregate token usage. A verdict of `needs_revision` means another evaluation cycle follows; `satisfied`, `max_iterations_reached`, `failed`, or `interrupted` are terminal — no further evaluation cycles follow. - `ID string` Unique identifier for this event. - `Explanation string` Human-readable explanation of the verdict. For `needs_revision`, describes which criteria failed and why. - `Iteration int64` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `OutcomeEvaluationStartID string` The id of the corresponding `span.outcome_evaluation_start` event. - `OutcomeID string` The `outc_` ID of the outcome being evaluated. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Result string` Evaluation verdict. 'satisfied': criteria met, session goes idle. 'needs_revision': criteria not met, another revision cycle follows. 'max_iterations_reached': evaluation budget exhausted with criteria still unmet — one final acknowledgment turn follows before the session goes idle, but no further evaluation runs. 'failed': grader determined the rubric does not apply to the deliverables. 'interrupted': user sent an interrupt while evaluation was in progress. - `Type BetaManagedAgentsSpanOutcomeEvaluationEndEventType` - `const BetaManagedAgentsSpanOutcomeEvaluationEndEventTypeSpanOutcomeEvaluationEnd BetaManagedAgentsSpanOutcomeEvaluationEndEventType = "span.outcome_evaluation_end"` - `Usage BetaManagedAgentsSpanModelUsage` Token usage for a single model request. - `CacheCreationInputTokens int64` Tokens used to create prompt cache in this request. - `CacheReadInputTokens int64` Tokens read from prompt cache in this request. - `InputTokens int64` Input tokens consumed by this request. - `OutputTokens int64` Output tokens generated by this request. - `Speed BetaManagedAgentsSpanModelUsageSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsSpanModelUsageSpeedStandard BetaManagedAgentsSpanModelUsageSpeed = "standard"` - `const BetaManagedAgentsSpanModelUsageSpeedFast BetaManagedAgentsSpanModelUsageSpeed = "fast"` - `type BetaManagedAgentsSpanModelRequestStartEvent struct{…}` Emitted when a model request is initiated by the agent. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanModelRequestStartEventType` - `const BetaManagedAgentsSpanModelRequestStartEventTypeSpanModelRequestStart BetaManagedAgentsSpanModelRequestStartEventType = "span.model_request_start"` - `type BetaManagedAgentsSpanModelRequestEndEvent struct{…}` Emitted when a model request completes. - `ID string` Unique identifier for this event. - `IsError bool` Whether the model request resulted in an error. - `ModelRequestStartID string` The id of the corresponding `span.model_request_start` event. - `ModelUsage BetaManagedAgentsSpanModelUsage` Token usage for a single model request. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanModelRequestEndEventType` - `const BetaManagedAgentsSpanModelRequestEndEventTypeSpanModelRequestEnd BetaManagedAgentsSpanModelRequestEndEventType = "span.model_request_end"` - `type BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent struct{…}` Periodic heartbeat emitted while an outcome evaluation cycle is in progress. Distinguishes 'evaluation is actively running' from 'evaluation is stuck' between the corresponding `span.outcome_evaluation_start` and `span.outcome_evaluation_end` events. - `ID string` Unique identifier for this event. - `Iteration int64` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `OutcomeID string` The `outc_` ID of the outcome being evaluated. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanOutcomeEvaluationOngoingEventType` - `const BetaManagedAgentsSpanOutcomeEvaluationOngoingEventTypeSpanOutcomeEvaluationOngoing BetaManagedAgentsSpanOutcomeEvaluationOngoingEventType = "span.outcome_evaluation_ongoing"` - `type BetaManagedAgentsUserDefineOutcomeEvent struct{…}` Echo of a `user.define_outcome` input event. Carries the server-generated `outcome_id` that subsequent `span.outcome_evaluation_*` events reference. - `ID string` Unique identifier for this event. - `Description string` What the agent should produce. Copied from the input event. - `MaxIterations int64` Evaluate-then-revise cycles before giving up. Default 3, max 20. - `OutcomeID string` Server-generated `outc_` ID for this outcome. Referenced by `span.outcome_evaluation_*` events and the session's `outcome_evaluations` list. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Rubric BetaManagedAgentsUserDefineOutcomeEventRubricUnion` Rubric for grading the quality of an outcome. - `type BetaManagedAgentsFileRubric struct{…}` Rubric referenced by a file uploaded via the Files API. - `FileID string` ID of the rubric file. - `Type BetaManagedAgentsFileRubricType` - `const BetaManagedAgentsFileRubricTypeFile BetaManagedAgentsFileRubricType = "file"` - `type BetaManagedAgentsTextRubric struct{…}` Rubric content provided inline as text. - `Content string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `Type BetaManagedAgentsTextRubricType` - `const BetaManagedAgentsTextRubricTypeText BetaManagedAgentsTextRubricType = "text"` - `Type BetaManagedAgentsUserDefineOutcomeEventType` - `const BetaManagedAgentsUserDefineOutcomeEventTypeUserDefineOutcome BetaManagedAgentsUserDefineOutcomeEventType = "user.define_outcome"` - `type BetaManagedAgentsSessionDeletedEvent struct{…}` Emitted when a session has been deleted. Terminates any active event stream — no further events will be emitted for this session. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionDeletedEventType` - `const BetaManagedAgentsSessionDeletedEventTypeSessionDeleted BetaManagedAgentsSessionDeletedEventType = "session.deleted"` - `type BetaManagedAgentsSessionThreadStatusRunningEvent struct{…}` A session thread has begun executing. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that started running. - `Type BetaManagedAgentsSessionThreadStatusRunningEventType` - `const BetaManagedAgentsSessionThreadStatusRunningEventTypeSessionThreadStatusRunning BetaManagedAgentsSessionThreadStatusRunningEventType = "session.thread_status_running"` - `type BetaManagedAgentsSessionThreadStatusIdleEvent struct{…}` A session thread has yielded and is awaiting input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that went idle. - `StopReason BetaManagedAgentsSessionThreadStatusIdleEventStopReasonUnion` The agent completed its turn naturally and is ready for the next user message. - `type BetaManagedAgentsSessionEndTurn struct{…}` The agent completed its turn naturally and is ready for the next user message. - `type BetaManagedAgentsSessionRequiresAction struct{…}` The agent is idle waiting on one or more blocking user-input events (tool confirmation, custom tool result, etc.). Resolving all of them transitions the session back to running. - `type BetaManagedAgentsSessionRetriesExhausted struct{…}` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `Type BetaManagedAgentsSessionThreadStatusIdleEventType` - `const BetaManagedAgentsSessionThreadStatusIdleEventTypeSessionThreadStatusIdle BetaManagedAgentsSessionThreadStatusIdleEventType = "session.thread_status_idle"` - `type BetaManagedAgentsSessionThreadStatusTerminatedEvent struct{…}` A session thread has terminated and will accept no further input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that terminated. - `Type BetaManagedAgentsSessionThreadStatusTerminatedEventType` - `const BetaManagedAgentsSessionThreadStatusTerminatedEventTypeSessionThreadStatusTerminated BetaManagedAgentsSessionThreadStatusTerminatedEventType = "session.thread_status_terminated"` - `type BetaManagedAgentsUserToolResultEvent struct{…}` Event sent by the client providing the result of an agent-toolset tool execution. Only valid on `self_hosted` environments, where sandbox-routed tools are executed by the client rather than the server. - `ID string` Unique identifier for this event. - `ToolUseID string` The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserToolResultEventType` - `const BetaManagedAgentsUserToolResultEventTypeUserToolResult BetaManagedAgentsUserToolResultEventType = "user.tool_result"` - `Content []BetaManagedAgentsUserToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `IsError bool` Whether the tool execution resulted in an error. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Routes this result to a subagent thread. Copy from the `agent.tool_use` event's `session_thread_id`. - `type BetaManagedAgentsSessionThreadStatusRescheduledEvent struct{…}` A session thread hit a transient error and is retrying automatically. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that is retrying. - `Type BetaManagedAgentsSessionThreadStatusRescheduledEventType` - `const BetaManagedAgentsSessionThreadStatusRescheduledEventTypeSessionThreadStatusRescheduled BetaManagedAgentsSessionThreadStatusRescheduledEventType = "session.thread_status_rescheduled"` - `type BetaManagedAgentsSessionUpdatedEvent struct{…}` Emitted when an UpdateSession request changed at least one field. Carries only the fields that changed; absent fields were not part of the update. The new configuration applies from the next turn. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionUpdatedEventType` - `const BetaManagedAgentsSessionUpdatedEventTypeSessionUpdated BetaManagedAgentsSessionUpdatedEventType = "session.updated"` - `Agent BetaManagedAgentsSessionAgent` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Multiagent BetaManagedAgentsSessionMultiagentCoordinator` Resolved coordinator topology with full agent definitions for each roster member. - `Agents []BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `Name string` - `Skills []BetaManagedAgentsSessionThreadAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsSessionThreadAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsSessionThreadAgentType` - `const BetaManagedAgentsSessionThreadAgentTypeAgent BetaManagedAgentsSessionThreadAgentType = "agent"` - `Version int64` - `Type BetaManagedAgentsSessionMultiagentCoordinatorType` - `const BetaManagedAgentsSessionMultiagentCoordinatorTypeCoordinator BetaManagedAgentsSessionMultiagentCoordinatorType = "coordinator"` - `Name string` - `Skills []BetaManagedAgentsSessionAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `System string` - `Tools []BetaManagedAgentsSessionAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `type BetaManagedAgentsMCPToolset struct{…}` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Type BetaManagedAgentsSessionAgentType` - `const BetaManagedAgentsSessionAgentTypeAgent BetaManagedAgentsSessionAgentType = "agent"` - `Version int64` - `Metadata map[string, string]` The session's full metadata bag after the update. Present when the update set non-empty metadata; absent when metadata was unchanged or cleared to empty. - `Title string` The session's new title. Present only when the update changed it. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) page, err := client.Beta.Sessions.Events.List( context.TODO(), "sesn_011CZkZAtmR3yMPDzynEDxu7", anthropic.BetaSessionEventListParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "data": [ { "id": "sevt_011CZkZGOp0iBcp4kaQSihUmy", "content": [ { "text": "Where is my order #1234?", "type": "text" } ], "type": "user.message", "processed_at": "2026-03-15T10:00:00Z" }, { "id": "sevt_011CZkZHPq1jCdq5lbRTjiVnz", "content": [ { "text": "Let me look up order #1234 for you.", "type": "text" } ], "processed_at": "2026-03-15T10:00:00Z", "type": "agent.message" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ## Send Events `client.Beta.Sessions.Events.Send(ctx, sessionID, params) (*BetaManagedAgentsSendSessionEvents, error)` **post** `/v1/sessions/{session_id}/events` Send Events ### Parameters - `sessionID string` - `params BetaSessionEventSendParams` - `Events param.Field[[]BetaManagedAgentsEventParamsUnionResp]` Body param: Events to send to the `session`. - `type BetaManagedAgentsUserMessageEventParamsResp struct{…}` Parameters for sending a user message to the session. - `Content []BetaManagedAgentsUserMessageEventParamsContentUnionResp` Array of content blocks for the user message. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `const BetaManagedAgentsTextBlockTypeText BetaManagedAgentsTextBlockType = "text"` - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `Source BetaManagedAgentsImageBlockSourceUnion` Union type for image source variants. - `type BetaManagedAgentsBase64ImageSource struct{…}` Base64-encoded image data. - `Data string` Base64-encoded image data. - `MediaType string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `Type BetaManagedAgentsBase64ImageSourceType` - `const BetaManagedAgentsBase64ImageSourceTypeBase64 BetaManagedAgentsBase64ImageSourceType = "base64"` - `type BetaManagedAgentsURLImageSource struct{…}` Image referenced by URL. - `Type BetaManagedAgentsURLImageSourceType` - `const BetaManagedAgentsURLImageSourceTypeURL BetaManagedAgentsURLImageSourceType = "url"` - `URL string` URL of the image to fetch. - `type BetaManagedAgentsFileImageSource struct{…}` Image referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileImageSourceType` - `const BetaManagedAgentsFileImageSourceTypeFile BetaManagedAgentsFileImageSourceType = "file"` - `Type BetaManagedAgentsImageBlockType` - `const BetaManagedAgentsImageBlockTypeImage BetaManagedAgentsImageBlockType = "image"` - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `Source BetaManagedAgentsDocumentBlockSourceUnion` Union type for document source variants. - `type BetaManagedAgentsBase64DocumentSource struct{…}` Base64-encoded document data. - `Data string` Base64-encoded document data. - `MediaType string` MIME type of the document (e.g., "application/pdf"). - `Type BetaManagedAgentsBase64DocumentSourceType` - `const BetaManagedAgentsBase64DocumentSourceTypeBase64 BetaManagedAgentsBase64DocumentSourceType = "base64"` - `type BetaManagedAgentsPlainTextDocumentSource struct{…}` Plain text document content. - `Data string` The plain text content. - `MediaType BetaManagedAgentsPlainTextDocumentSourceMediaType` MIME type of the text content. Must be "text/plain". - `const BetaManagedAgentsPlainTextDocumentSourceMediaTypeTextPlain BetaManagedAgentsPlainTextDocumentSourceMediaType = "text/plain"` - `Type BetaManagedAgentsPlainTextDocumentSourceType` - `const BetaManagedAgentsPlainTextDocumentSourceTypeText BetaManagedAgentsPlainTextDocumentSourceType = "text"` - `type BetaManagedAgentsURLDocumentSource struct{…}` Document referenced by URL. - `Type BetaManagedAgentsURLDocumentSourceType` - `const BetaManagedAgentsURLDocumentSourceTypeURL BetaManagedAgentsURLDocumentSourceType = "url"` - `URL string` URL of the document to fetch. - `type BetaManagedAgentsFileDocumentSource struct{…}` Document referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileDocumentSourceType` - `const BetaManagedAgentsFileDocumentSourceTypeFile BetaManagedAgentsFileDocumentSourceType = "file"` - `Type BetaManagedAgentsDocumentBlockType` - `const BetaManagedAgentsDocumentBlockTypeDocument BetaManagedAgentsDocumentBlockType = "document"` - `Context string` Additional context about the document for the model. - `Title string` The title of the document. - `Type BetaManagedAgentsUserMessageEventParamsType` - `const BetaManagedAgentsUserMessageEventParamsTypeUserMessage BetaManagedAgentsUserMessageEventParamsType = "user.message"` - `type BetaManagedAgentsUserInterruptEventParamsResp struct{…}` Parameters for sending an interrupt to pause the agent. - `Type BetaManagedAgentsUserInterruptEventParamsType` - `const BetaManagedAgentsUserInterruptEventParamsTypeUserInterrupt BetaManagedAgentsUserInterruptEventParamsType = "user.interrupt"` - `SessionThreadID string` If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. - `type BetaManagedAgentsUserToolConfirmationEventParamsResp struct{…}` Parameters for confirming or denying a tool execution request. - `Result BetaManagedAgentsUserToolConfirmationEventParamsResult` UserToolConfirmationResult enum - `const BetaManagedAgentsUserToolConfirmationEventParamsResultAllow BetaManagedAgentsUserToolConfirmationEventParamsResult = "allow"` - `const BetaManagedAgentsUserToolConfirmationEventParamsResultDeny BetaManagedAgentsUserToolConfirmationEventParamsResult = "deny"` - `ToolUseID string` The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserToolConfirmationEventParamsType` - `const BetaManagedAgentsUserToolConfirmationEventParamsTypeUserToolConfirmation BetaManagedAgentsUserToolConfirmationEventParamsType = "user.tool_confirmation"` - `DenyMessage string` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. - `type BetaManagedAgentsUserCustomToolResultEventParamsResp struct{…}` Parameters for providing the result of a custom tool execution. - `CustomToolUseID string` The id of the `agent.custom_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserCustomToolResultEventParamsType` - `const BetaManagedAgentsUserCustomToolResultEventParamsTypeUserCustomToolResult BetaManagedAgentsUserCustomToolResultEventParamsType = "user.custom_tool_result"` - `Content []BetaManagedAgentsUserCustomToolResultEventParamsContentUnionResp` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `Citations BetaManagedAgentsSearchResultCitations` Citation settings for a search result. - `Enabled bool` Whether citations are enabled for this search result. - `Content []BetaManagedAgentsSearchResultContent` Array of text content blocks from the search result. - `Text string` The text content. - `Type BetaManagedAgentsSearchResultContentType` - `const BetaManagedAgentsSearchResultContentTypeText BetaManagedAgentsSearchResultContentType = "text"` - `Source string` The URL source of the search result. - `Title string` The title of the search result. - `Type BetaManagedAgentsSearchResultBlockType` - `const BetaManagedAgentsSearchResultBlockTypeSearchResult BetaManagedAgentsSearchResultBlockType = "search_result"` - `IsError bool` Whether the tool execution resulted in an error. - `type BetaManagedAgentsUserDefineOutcomeEventParamsResp struct{…}` Parameters for defining an outcome the agent should work toward. The agent begins work on receipt. - `Description string` What the agent should produce. This is the task specification. - `Rubric BetaManagedAgentsUserDefineOutcomeEventParamsRubricUnionResp` Rubric for grading the quality of an outcome. - `type BetaManagedAgentsFileRubricParamsResp struct{…}` Rubric referenced by a file uploaded via the Files API. - `FileID string` ID of the rubric file. - `Type BetaManagedAgentsFileRubricParamsType` - `const BetaManagedAgentsFileRubricParamsTypeFile BetaManagedAgentsFileRubricParamsType = "file"` - `type BetaManagedAgentsTextRubricParamsResp struct{…}` Rubric content provided inline as text. - `Content string` Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters. - `Type BetaManagedAgentsTextRubricParamsType` - `const BetaManagedAgentsTextRubricParamsTypeText BetaManagedAgentsTextRubricParamsType = "text"` - `Type BetaManagedAgentsUserDefineOutcomeEventParamsType` - `const BetaManagedAgentsUserDefineOutcomeEventParamsTypeUserDefineOutcome BetaManagedAgentsUserDefineOutcomeEventParamsType = "user.define_outcome"` - `MaxIterations int64` Eval→revision cycles before giving up. Default 3, max 20. - `type BetaManagedAgentsUserToolResultEventParamsResp struct{…}` Parameters for providing the result of an agent-toolset tool execution. Only valid on `self_hosted` environments, where sandbox-routed tools are executed by the client rather than the server. - `ToolUseID string` The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserToolResultEventParamsType` - `const BetaManagedAgentsUserToolResultEventParamsTypeUserToolResult BetaManagedAgentsUserToolResultEventParamsType = "user.tool_result"` - `Content []BetaManagedAgentsUserToolResultEventParamsContentUnionResp` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `IsError bool` Whether the tool execution resulted in an error. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsSendSessionEvents struct{…}` Events that were successfully sent to the session. - `Data []BetaManagedAgentsSendSessionEventsDataUnion` Sent events - `type BetaManagedAgentsUserMessageEvent struct{…}` A user message event in the session conversation. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsUserMessageEventContentUnion` Array of content blocks comprising the user message. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `const BetaManagedAgentsTextBlockTypeText BetaManagedAgentsTextBlockType = "text"` - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `Source BetaManagedAgentsImageBlockSourceUnion` Union type for image source variants. - `type BetaManagedAgentsBase64ImageSource struct{…}` Base64-encoded image data. - `Data string` Base64-encoded image data. - `MediaType string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `Type BetaManagedAgentsBase64ImageSourceType` - `const BetaManagedAgentsBase64ImageSourceTypeBase64 BetaManagedAgentsBase64ImageSourceType = "base64"` - `type BetaManagedAgentsURLImageSource struct{…}` Image referenced by URL. - `Type BetaManagedAgentsURLImageSourceType` - `const BetaManagedAgentsURLImageSourceTypeURL BetaManagedAgentsURLImageSourceType = "url"` - `URL string` URL of the image to fetch. - `type BetaManagedAgentsFileImageSource struct{…}` Image referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileImageSourceType` - `const BetaManagedAgentsFileImageSourceTypeFile BetaManagedAgentsFileImageSourceType = "file"` - `Type BetaManagedAgentsImageBlockType` - `const BetaManagedAgentsImageBlockTypeImage BetaManagedAgentsImageBlockType = "image"` - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `Source BetaManagedAgentsDocumentBlockSourceUnion` Union type for document source variants. - `type BetaManagedAgentsBase64DocumentSource struct{…}` Base64-encoded document data. - `Data string` Base64-encoded document data. - `MediaType string` MIME type of the document (e.g., "application/pdf"). - `Type BetaManagedAgentsBase64DocumentSourceType` - `const BetaManagedAgentsBase64DocumentSourceTypeBase64 BetaManagedAgentsBase64DocumentSourceType = "base64"` - `type BetaManagedAgentsPlainTextDocumentSource struct{…}` Plain text document content. - `Data string` The plain text content. - `MediaType BetaManagedAgentsPlainTextDocumentSourceMediaType` MIME type of the text content. Must be "text/plain". - `const BetaManagedAgentsPlainTextDocumentSourceMediaTypeTextPlain BetaManagedAgentsPlainTextDocumentSourceMediaType = "text/plain"` - `Type BetaManagedAgentsPlainTextDocumentSourceType` - `const BetaManagedAgentsPlainTextDocumentSourceTypeText BetaManagedAgentsPlainTextDocumentSourceType = "text"` - `type BetaManagedAgentsURLDocumentSource struct{…}` Document referenced by URL. - `Type BetaManagedAgentsURLDocumentSourceType` - `const BetaManagedAgentsURLDocumentSourceTypeURL BetaManagedAgentsURLDocumentSourceType = "url"` - `URL string` URL of the document to fetch. - `type BetaManagedAgentsFileDocumentSource struct{…}` Document referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileDocumentSourceType` - `const BetaManagedAgentsFileDocumentSourceTypeFile BetaManagedAgentsFileDocumentSourceType = "file"` - `Type BetaManagedAgentsDocumentBlockType` - `const BetaManagedAgentsDocumentBlockTypeDocument BetaManagedAgentsDocumentBlockType = "document"` - `Context string` Additional context about the document for the model. - `Title string` The title of the document. - `Type BetaManagedAgentsUserMessageEventType` - `const BetaManagedAgentsUserMessageEventTypeUserMessage BetaManagedAgentsUserMessageEventType = "user.message"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `type BetaManagedAgentsUserInterruptEvent struct{…}` An interrupt event that pauses agent execution and returns control to the user. - `ID string` Unique identifier for this event. - `Type BetaManagedAgentsUserInterruptEventType` - `const BetaManagedAgentsUserInterruptEventTypeUserInterrupt BetaManagedAgentsUserInterruptEventType = "user.interrupt"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. - `type BetaManagedAgentsUserToolConfirmationEvent struct{…}` A tool confirmation event that approves or denies a pending tool execution. - `ID string` Unique identifier for this event. - `Result BetaManagedAgentsUserToolConfirmationEventResult` UserToolConfirmationResult enum - `const BetaManagedAgentsUserToolConfirmationEventResultAllow BetaManagedAgentsUserToolConfirmationEventResult = "allow"` - `const BetaManagedAgentsUserToolConfirmationEventResultDeny BetaManagedAgentsUserToolConfirmationEventResult = "deny"` - `ToolUseID string` The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserToolConfirmationEventType` - `const BetaManagedAgentsUserToolConfirmationEventTypeUserToolConfirmation BetaManagedAgentsUserToolConfirmationEventType = "user.tool_confirmation"` - `DenyMessage string` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` When set, the confirmation routes to this subagent's thread rather than the primary. Echo this from the `session_thread_id` on the `agent.tool_use` or `agent.mcp_tool_use` event that prompted the approval. - `type BetaManagedAgentsUserCustomToolResultEvent struct{…}` Event sent by the client providing the result of a custom tool execution. - `ID string` Unique identifier for this event. - `CustomToolUseID string` The id of the `agent.custom_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserCustomToolResultEventType` - `const BetaManagedAgentsUserCustomToolResultEventTypeUserCustomToolResult BetaManagedAgentsUserCustomToolResultEventType = "user.custom_tool_result"` - `Content []BetaManagedAgentsUserCustomToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `Citations BetaManagedAgentsSearchResultCitations` Citation settings for a search result. - `Enabled bool` Whether citations are enabled for this search result. - `Content []BetaManagedAgentsSearchResultContent` Array of text content blocks from the search result. - `Text string` The text content. - `Type BetaManagedAgentsSearchResultContentType` - `const BetaManagedAgentsSearchResultContentTypeText BetaManagedAgentsSearchResultContentType = "text"` - `Source string` The URL source of the search result. - `Title string` The title of the search result. - `Type BetaManagedAgentsSearchResultBlockType` - `const BetaManagedAgentsSearchResultBlockTypeSearchResult BetaManagedAgentsSearchResultBlockType = "search_result"` - `IsError bool` Whether the tool execution resulted in an error. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Routes this result to a subagent thread. Copy from the `agent.custom_tool_use` event's `session_thread_id`. - `type BetaManagedAgentsUserDefineOutcomeEvent struct{…}` Echo of a `user.define_outcome` input event. Carries the server-generated `outcome_id` that subsequent `span.outcome_evaluation_*` events reference. - `ID string` Unique identifier for this event. - `Description string` What the agent should produce. Copied from the input event. - `MaxIterations int64` Evaluate-then-revise cycles before giving up. Default 3, max 20. - `OutcomeID string` Server-generated `outc_` ID for this outcome. Referenced by `span.outcome_evaluation_*` events and the session's `outcome_evaluations` list. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Rubric BetaManagedAgentsUserDefineOutcomeEventRubricUnion` Rubric for grading the quality of an outcome. - `type BetaManagedAgentsFileRubric struct{…}` Rubric referenced by a file uploaded via the Files API. - `FileID string` ID of the rubric file. - `Type BetaManagedAgentsFileRubricType` - `const BetaManagedAgentsFileRubricTypeFile BetaManagedAgentsFileRubricType = "file"` - `type BetaManagedAgentsTextRubric struct{…}` Rubric content provided inline as text. - `Content string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `Type BetaManagedAgentsTextRubricType` - `const BetaManagedAgentsTextRubricTypeText BetaManagedAgentsTextRubricType = "text"` - `Type BetaManagedAgentsUserDefineOutcomeEventType` - `const BetaManagedAgentsUserDefineOutcomeEventTypeUserDefineOutcome BetaManagedAgentsUserDefineOutcomeEventType = "user.define_outcome"` - `type BetaManagedAgentsUserToolResultEvent struct{…}` Event sent by the client providing the result of an agent-toolset tool execution. Only valid on `self_hosted` environments, where sandbox-routed tools are executed by the client rather than the server. - `ID string` Unique identifier for this event. - `ToolUseID string` The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserToolResultEventType` - `const BetaManagedAgentsUserToolResultEventTypeUserToolResult BetaManagedAgentsUserToolResultEventType = "user.tool_result"` - `Content []BetaManagedAgentsUserToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `IsError bool` Whether the tool execution resulted in an error. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Routes this result to a subagent thread. Copy from the `agent.tool_use` event's `session_thread_id`. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsSendSessionEvents, err := client.Beta.Sessions.Events.Send( context.TODO(), "sesn_011CZkZAtmR3yMPDzynEDxu7", anthropic.BetaSessionEventSendParams{ Events: []anthropic.BetaManagedAgentsEventParamsUnion{anthropic.BetaManagedAgentsEventParamsUnion{ OfUserMessage: &anthropic.BetaManagedAgentsUserMessageEventParams{ Content: []anthropic.BetaManagedAgentsUserMessageEventParamsContentUnion{anthropic.BetaManagedAgentsUserMessageEventParamsContentUnion{ OfText: &anthropic.BetaManagedAgentsTextBlockParam{ Text: "Where is my order #1234?", Type: anthropic.BetaManagedAgentsTextBlockTypeText, }, }}, Type: anthropic.BetaManagedAgentsUserMessageEventParamsTypeUserMessage, }, }}, }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsSendSessionEvents.Data) } ``` #### Response ```json { "data": [ { "id": "sevt_011CZkZGOp0iBcp4kaQSihUmy", "content": [ { "text": "Where is my order #1234?", "type": "text" } ], "type": "user.message", "processed_at": "2026-03-15T10:00:00Z" } ] } ``` ## Stream Events `client.Beta.Sessions.Events.Stream(ctx, sessionID, query) (*BetaManagedAgentsStreamSessionEventsUnion, error)` **get** `/v1/sessions/{session_id}/events/stream` Stream Events ### Parameters - `sessionID string` - `query BetaSessionEventStreamParams` - `Betas param.Field[[]AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsStreamSessionEventsUnion interface{…}` Server-sent event in the session stream. - `type BetaManagedAgentsUserMessageEvent struct{…}` A user message event in the session conversation. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsUserMessageEventContentUnion` Array of content blocks comprising the user message. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `const BetaManagedAgentsTextBlockTypeText BetaManagedAgentsTextBlockType = "text"` - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `Source BetaManagedAgentsImageBlockSourceUnion` Union type for image source variants. - `type BetaManagedAgentsBase64ImageSource struct{…}` Base64-encoded image data. - `Data string` Base64-encoded image data. - `MediaType string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `Type BetaManagedAgentsBase64ImageSourceType` - `const BetaManagedAgentsBase64ImageSourceTypeBase64 BetaManagedAgentsBase64ImageSourceType = "base64"` - `type BetaManagedAgentsURLImageSource struct{…}` Image referenced by URL. - `Type BetaManagedAgentsURLImageSourceType` - `const BetaManagedAgentsURLImageSourceTypeURL BetaManagedAgentsURLImageSourceType = "url"` - `URL string` URL of the image to fetch. - `type BetaManagedAgentsFileImageSource struct{…}` Image referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileImageSourceType` - `const BetaManagedAgentsFileImageSourceTypeFile BetaManagedAgentsFileImageSourceType = "file"` - `Type BetaManagedAgentsImageBlockType` - `const BetaManagedAgentsImageBlockTypeImage BetaManagedAgentsImageBlockType = "image"` - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `Source BetaManagedAgentsDocumentBlockSourceUnion` Union type for document source variants. - `type BetaManagedAgentsBase64DocumentSource struct{…}` Base64-encoded document data. - `Data string` Base64-encoded document data. - `MediaType string` MIME type of the document (e.g., "application/pdf"). - `Type BetaManagedAgentsBase64DocumentSourceType` - `const BetaManagedAgentsBase64DocumentSourceTypeBase64 BetaManagedAgentsBase64DocumentSourceType = "base64"` - `type BetaManagedAgentsPlainTextDocumentSource struct{…}` Plain text document content. - `Data string` The plain text content. - `MediaType BetaManagedAgentsPlainTextDocumentSourceMediaType` MIME type of the text content. Must be "text/plain". - `const BetaManagedAgentsPlainTextDocumentSourceMediaTypeTextPlain BetaManagedAgentsPlainTextDocumentSourceMediaType = "text/plain"` - `Type BetaManagedAgentsPlainTextDocumentSourceType` - `const BetaManagedAgentsPlainTextDocumentSourceTypeText BetaManagedAgentsPlainTextDocumentSourceType = "text"` - `type BetaManagedAgentsURLDocumentSource struct{…}` Document referenced by URL. - `Type BetaManagedAgentsURLDocumentSourceType` - `const BetaManagedAgentsURLDocumentSourceTypeURL BetaManagedAgentsURLDocumentSourceType = "url"` - `URL string` URL of the document to fetch. - `type BetaManagedAgentsFileDocumentSource struct{…}` Document referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileDocumentSourceType` - `const BetaManagedAgentsFileDocumentSourceTypeFile BetaManagedAgentsFileDocumentSourceType = "file"` - `Type BetaManagedAgentsDocumentBlockType` - `const BetaManagedAgentsDocumentBlockTypeDocument BetaManagedAgentsDocumentBlockType = "document"` - `Context string` Additional context about the document for the model. - `Title string` The title of the document. - `Type BetaManagedAgentsUserMessageEventType` - `const BetaManagedAgentsUserMessageEventTypeUserMessage BetaManagedAgentsUserMessageEventType = "user.message"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `type BetaManagedAgentsUserInterruptEvent struct{…}` An interrupt event that pauses agent execution and returns control to the user. - `ID string` Unique identifier for this event. - `Type BetaManagedAgentsUserInterruptEventType` - `const BetaManagedAgentsUserInterruptEventTypeUserInterrupt BetaManagedAgentsUserInterruptEventType = "user.interrupt"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. - `type BetaManagedAgentsUserToolConfirmationEvent struct{…}` A tool confirmation event that approves or denies a pending tool execution. - `ID string` Unique identifier for this event. - `Result BetaManagedAgentsUserToolConfirmationEventResult` UserToolConfirmationResult enum - `const BetaManagedAgentsUserToolConfirmationEventResultAllow BetaManagedAgentsUserToolConfirmationEventResult = "allow"` - `const BetaManagedAgentsUserToolConfirmationEventResultDeny BetaManagedAgentsUserToolConfirmationEventResult = "deny"` - `ToolUseID string` The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserToolConfirmationEventType` - `const BetaManagedAgentsUserToolConfirmationEventTypeUserToolConfirmation BetaManagedAgentsUserToolConfirmationEventType = "user.tool_confirmation"` - `DenyMessage string` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` When set, the confirmation routes to this subagent's thread rather than the primary. Echo this from the `session_thread_id` on the `agent.tool_use` or `agent.mcp_tool_use` event that prompted the approval. - `type BetaManagedAgentsUserCustomToolResultEvent struct{…}` Event sent by the client providing the result of a custom tool execution. - `ID string` Unique identifier for this event. - `CustomToolUseID string` The id of the `agent.custom_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserCustomToolResultEventType` - `const BetaManagedAgentsUserCustomToolResultEventTypeUserCustomToolResult BetaManagedAgentsUserCustomToolResultEventType = "user.custom_tool_result"` - `Content []BetaManagedAgentsUserCustomToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `Citations BetaManagedAgentsSearchResultCitations` Citation settings for a search result. - `Enabled bool` Whether citations are enabled for this search result. - `Content []BetaManagedAgentsSearchResultContent` Array of text content blocks from the search result. - `Text string` The text content. - `Type BetaManagedAgentsSearchResultContentType` - `const BetaManagedAgentsSearchResultContentTypeText BetaManagedAgentsSearchResultContentType = "text"` - `Source string` The URL source of the search result. - `Title string` The title of the search result. - `Type BetaManagedAgentsSearchResultBlockType` - `const BetaManagedAgentsSearchResultBlockTypeSearchResult BetaManagedAgentsSearchResultBlockType = "search_result"` - `IsError bool` Whether the tool execution resulted in an error. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Routes this result to a subagent thread. Copy from the `agent.custom_tool_use` event's `session_thread_id`. - `type BetaManagedAgentsAgentCustomToolUseEvent struct{…}` Event emitted when the agent calls a custom tool. The session goes idle until the client sends a `user.custom_tool_result` event with the result. - `ID string` Unique identifier for this event. - `Input map[string, any]` Input parameters for the tool call. - `Name string` Name of the custom tool being called. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentCustomToolUseEventType` - `const BetaManagedAgentsAgentCustomToolUseEventTypeAgentCustomToolUse BetaManagedAgentsAgentCustomToolUseEventType = "agent.custom_tool_use"` - `SessionThreadID string` When set, this event was cross-posted from a subagent's thread to surface its custom tool use on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.custom_tool_result` event to route the result back. - `type BetaManagedAgentsAgentMessageEvent struct{…}` An agent response event in the session conversation. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsTextBlock` Array of text blocks comprising the agent response. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentMessageEventType` - `const BetaManagedAgentsAgentMessageEventTypeAgentMessage BetaManagedAgentsAgentMessageEventType = "agent.message"` - `type BetaManagedAgentsAgentThinkingEvent struct{…}` Indicates the agent is making forward progress via extended thinking. A progress signal, not a content carrier. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentThinkingEventType` - `const BetaManagedAgentsAgentThinkingEventTypeAgentThinking BetaManagedAgentsAgentThinkingEventType = "agent.thinking"` - `type BetaManagedAgentsAgentMCPToolUseEvent struct{…}` Event emitted when the agent invokes a tool provided by an MCP server. - `ID string` Unique identifier for this event. - `Input map[string, any]` Input parameters for the tool call. - `MCPServerName string` Name of the MCP server providing the tool. - `Name string` Name of the MCP tool being used. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentMCPToolUseEventType` - `const BetaManagedAgentsAgentMCPToolUseEventTypeAgentMCPToolUse BetaManagedAgentsAgentMCPToolUseEventType = "agent.mcp_tool_use"` - `EvaluatedPermission BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission` AgentEvaluatedPermission enum - `const BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermissionAllow BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission = "allow"` - `const BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermissionAsk BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission = "ask"` - `const BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermissionDeny BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission = "deny"` - `SessionThreadID string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `type BetaManagedAgentsAgentMCPToolResultEvent struct{…}` Event representing the result of an MCP tool execution. - `ID string` Unique identifier for this event. - `MCPToolUseID string` The id of the `agent.mcp_tool_use` event this result corresponds to. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentMCPToolResultEventType` - `const BetaManagedAgentsAgentMCPToolResultEventTypeAgentMCPToolResult BetaManagedAgentsAgentMCPToolResultEventType = "agent.mcp_tool_result"` - `Content []BetaManagedAgentsAgentMCPToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `IsError bool` Whether the tool execution resulted in an error. - `type BetaManagedAgentsAgentToolUseEvent struct{…}` Event emitted when the agent invokes a built-in agent tool. - `ID string` Unique identifier for this event. - `Input map[string, any]` Input parameters for the tool call. - `Name string` Name of the agent tool being used. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentToolUseEventType` - `const BetaManagedAgentsAgentToolUseEventTypeAgentToolUse BetaManagedAgentsAgentToolUseEventType = "agent.tool_use"` - `EvaluatedPermission BetaManagedAgentsAgentToolUseEventEvaluatedPermission` AgentEvaluatedPermission enum - `const BetaManagedAgentsAgentToolUseEventEvaluatedPermissionAllow BetaManagedAgentsAgentToolUseEventEvaluatedPermission = "allow"` - `const BetaManagedAgentsAgentToolUseEventEvaluatedPermissionAsk BetaManagedAgentsAgentToolUseEventEvaluatedPermission = "ask"` - `const BetaManagedAgentsAgentToolUseEventEvaluatedPermissionDeny BetaManagedAgentsAgentToolUseEventEvaluatedPermission = "deny"` - `SessionThreadID string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `type BetaManagedAgentsAgentToolResultEvent struct{…}` Event representing the result of an agent tool execution. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `ToolUseID string` The id of the `agent.tool_use` event this result corresponds to. - `Type BetaManagedAgentsAgentToolResultEventType` - `const BetaManagedAgentsAgentToolResultEventTypeAgentToolResult BetaManagedAgentsAgentToolResultEventType = "agent.tool_result"` - `Content []BetaManagedAgentsAgentToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `IsError bool` Whether the tool execution resulted in an error. - `type BetaManagedAgentsAgentThreadMessageReceivedEvent struct{…}` Delivery event written to the target thread's input stream when an agent-to-agent message arrives. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsAgentThreadMessageReceivedEventContentUnion` Message content blocks. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `FromSessionThreadID string` Public `sthr_` ID of the thread that sent the message. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentThreadMessageReceivedEventType` - `const BetaManagedAgentsAgentThreadMessageReceivedEventTypeAgentThreadMessageReceived BetaManagedAgentsAgentThreadMessageReceivedEventType = "agent.thread_message_received"` - `FromAgentName string` Name of the callable agent this message came from. Absent when received from the primary agent. - `type BetaManagedAgentsAgentThreadMessageSentEvent struct{…}` Observability event emitted to the sender's output stream when an agent-to-agent message is sent. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsAgentThreadMessageSentEventContentUnion` Message content blocks. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `ProcessedAt Time` A timestamp in RFC 3339 format - `ToSessionThreadID string` Public `sthr_` ID of the thread the message was sent to. - `Type BetaManagedAgentsAgentThreadMessageSentEventType` - `const BetaManagedAgentsAgentThreadMessageSentEventTypeAgentThreadMessageSent BetaManagedAgentsAgentThreadMessageSentEventType = "agent.thread_message_sent"` - `ToAgentName string` Name of the callable agent this message was sent to. Absent when sent to the primary agent. - `type BetaManagedAgentsAgentThreadContextCompactedEvent struct{…}` Indicates that context compaction (summarization) occurred during the session. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentThreadContextCompactedEventType` - `const BetaManagedAgentsAgentThreadContextCompactedEventTypeAgentThreadContextCompacted BetaManagedAgentsAgentThreadContextCompactedEventType = "agent.thread_context_compacted"` - `type BetaManagedAgentsSessionErrorEvent struct{…}` An error event indicating a problem occurred during session execution. - `ID string` Unique identifier for this event. - `Error BetaManagedAgentsSessionErrorEventErrorUnion` An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on `retry_status` and `message` alone. - `type BetaManagedAgentsUnknownError struct{…}` An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on `retry_status` and `message` alone. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsUnknownErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `Type BetaManagedAgentsRetryStatusRetryingType` - `const BetaManagedAgentsRetryStatusRetryingTypeRetrying BetaManagedAgentsRetryStatusRetryingType = "retrying"` - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `Type BetaManagedAgentsRetryStatusExhaustedType` - `const BetaManagedAgentsRetryStatusExhaustedTypeExhausted BetaManagedAgentsRetryStatusExhaustedType = "exhausted"` - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsRetryStatusTerminalType` - `const BetaManagedAgentsRetryStatusTerminalTypeTerminal BetaManagedAgentsRetryStatusTerminalType = "terminal"` - `Type BetaManagedAgentsUnknownErrorType` - `const BetaManagedAgentsUnknownErrorTypeUnknownError BetaManagedAgentsUnknownErrorType = "unknown_error"` - `type BetaManagedAgentsModelOverloadedError struct{…}` The model is currently overloaded. Emitted after automatic retries are exhausted. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsModelOverloadedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsModelOverloadedErrorType` - `const BetaManagedAgentsModelOverloadedErrorTypeModelOverloadedError BetaManagedAgentsModelOverloadedErrorType = "model_overloaded_error"` - `type BetaManagedAgentsModelRateLimitedError struct{…}` The model request was rate-limited. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsModelRateLimitedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsModelRateLimitedErrorType` - `const BetaManagedAgentsModelRateLimitedErrorTypeModelRateLimitedError BetaManagedAgentsModelRateLimitedErrorType = "model_rate_limited_error"` - `type BetaManagedAgentsModelRequestFailedError struct{…}` A model request failed for a reason other than overload or rate-limiting. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsModelRequestFailedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsModelRequestFailedErrorType` - `const BetaManagedAgentsModelRequestFailedErrorTypeModelRequestFailedError BetaManagedAgentsModelRequestFailedErrorType = "model_request_failed_error"` - `type BetaManagedAgentsMCPConnectionFailedError struct{…}` Failed to connect to an MCP server. - `MCPServerName string` Name of the MCP server that failed to connect. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsMCPConnectionFailedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsMCPConnectionFailedErrorType` - `const BetaManagedAgentsMCPConnectionFailedErrorTypeMCPConnectionFailedError BetaManagedAgentsMCPConnectionFailedErrorType = "mcp_connection_failed_error"` - `type BetaManagedAgentsMCPAuthenticationFailedError struct{…}` Authentication to an MCP server failed. - `MCPServerName string` Name of the MCP server that failed authentication. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsMCPAuthenticationFailedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsMCPAuthenticationFailedErrorType` - `const BetaManagedAgentsMCPAuthenticationFailedErrorTypeMCPAuthenticationFailedError BetaManagedAgentsMCPAuthenticationFailedErrorType = "mcp_authentication_failed_error"` - `type BetaManagedAgentsBillingError struct{…}` The caller's organization or workspace cannot make model requests — out of credits or spend limit reached. Retrying with the same credentials will not succeed; the caller must resolve the billing state. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsBillingErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsBillingErrorType` - `const BetaManagedAgentsBillingErrorTypeBillingError BetaManagedAgentsBillingErrorType = "billing_error"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionErrorEventType` - `const BetaManagedAgentsSessionErrorEventTypeSessionError BetaManagedAgentsSessionErrorEventType = "session.error"` - `type BetaManagedAgentsSessionStatusRescheduledEvent struct{…}` Indicates the session is recovering from an error state and is rescheduled for execution. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionStatusRescheduledEventType` - `const BetaManagedAgentsSessionStatusRescheduledEventTypeSessionStatusRescheduled BetaManagedAgentsSessionStatusRescheduledEventType = "session.status_rescheduled"` - `type BetaManagedAgentsSessionStatusRunningEvent struct{…}` Indicates the session is actively running and the agent is working. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionStatusRunningEventType` - `const BetaManagedAgentsSessionStatusRunningEventTypeSessionStatusRunning BetaManagedAgentsSessionStatusRunningEventType = "session.status_running"` - `type BetaManagedAgentsSessionStatusIdleEvent struct{…}` Indicates the agent has paused and is awaiting user input. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `StopReason BetaManagedAgentsSessionStatusIdleEventStopReasonUnion` The agent completed its turn naturally and is ready for the next user message. - `type BetaManagedAgentsSessionEndTurn struct{…}` The agent completed its turn naturally and is ready for the next user message. - `Type BetaManagedAgentsSessionEndTurnType` - `const BetaManagedAgentsSessionEndTurnTypeEndTurn BetaManagedAgentsSessionEndTurnType = "end_turn"` - `type BetaManagedAgentsSessionRequiresAction struct{…}` The agent is idle waiting on one or more blocking user-input events (tool confirmation, custom tool result, etc.). Resolving all of them transitions the session back to running. - `EventIDs []string` The ids of events the agent is blocked on. Resolving fewer than all re-emits `session.status_idle` with the remainder. - `Type BetaManagedAgentsSessionRequiresActionType` - `const BetaManagedAgentsSessionRequiresActionTypeRequiresAction BetaManagedAgentsSessionRequiresActionType = "requires_action"` - `type BetaManagedAgentsSessionRetriesExhausted struct{…}` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `Type BetaManagedAgentsSessionRetriesExhaustedType` - `const BetaManagedAgentsSessionRetriesExhaustedTypeRetriesExhausted BetaManagedAgentsSessionRetriesExhaustedType = "retries_exhausted"` - `Type BetaManagedAgentsSessionStatusIdleEventType` - `const BetaManagedAgentsSessionStatusIdleEventTypeSessionStatusIdle BetaManagedAgentsSessionStatusIdleEventType = "session.status_idle"` - `type BetaManagedAgentsSessionStatusTerminatedEvent struct{…}` Indicates the session has terminated, either due to an error or completion. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionStatusTerminatedEventType` - `const BetaManagedAgentsSessionStatusTerminatedEventTypeSessionStatusTerminated BetaManagedAgentsSessionStatusTerminatedEventType = "session.status_terminated"` - `type BetaManagedAgentsSessionThreadCreatedEvent struct{…}` Emitted when a subagent is spawned as a new thread. Written to the parent thread's output stream so clients observing the session see child creation. - `ID string` Unique identifier for this event. - `AgentName string` Name of the callable agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public `sthr_` ID of the newly created thread. - `Type BetaManagedAgentsSessionThreadCreatedEventType` - `const BetaManagedAgentsSessionThreadCreatedEventTypeSessionThreadCreated BetaManagedAgentsSessionThreadCreatedEventType = "session.thread_created"` - `type BetaManagedAgentsSpanOutcomeEvaluationStartEvent struct{…}` Emitted when an outcome evaluation cycle begins. - `ID string` Unique identifier for this event. - `Iteration int64` 0-indexed revision cycle. 0 is the first evaluation; 1 is the re-evaluation after the first revision; etc. - `OutcomeID string` The `outc_` ID of the outcome being evaluated. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanOutcomeEvaluationStartEventType` - `const BetaManagedAgentsSpanOutcomeEvaluationStartEventTypeSpanOutcomeEvaluationStart BetaManagedAgentsSpanOutcomeEvaluationStartEventType = "span.outcome_evaluation_start"` - `type BetaManagedAgentsSpanOutcomeEvaluationEndEvent struct{…}` Emitted when an outcome evaluation cycle completes. Carries the verdict and aggregate token usage. A verdict of `needs_revision` means another evaluation cycle follows; `satisfied`, `max_iterations_reached`, `failed`, or `interrupted` are terminal — no further evaluation cycles follow. - `ID string` Unique identifier for this event. - `Explanation string` Human-readable explanation of the verdict. For `needs_revision`, describes which criteria failed and why. - `Iteration int64` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `OutcomeEvaluationStartID string` The id of the corresponding `span.outcome_evaluation_start` event. - `OutcomeID string` The `outc_` ID of the outcome being evaluated. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Result string` Evaluation verdict. 'satisfied': criteria met, session goes idle. 'needs_revision': criteria not met, another revision cycle follows. 'max_iterations_reached': evaluation budget exhausted with criteria still unmet — one final acknowledgment turn follows before the session goes idle, but no further evaluation runs. 'failed': grader determined the rubric does not apply to the deliverables. 'interrupted': user sent an interrupt while evaluation was in progress. - `Type BetaManagedAgentsSpanOutcomeEvaluationEndEventType` - `const BetaManagedAgentsSpanOutcomeEvaluationEndEventTypeSpanOutcomeEvaluationEnd BetaManagedAgentsSpanOutcomeEvaluationEndEventType = "span.outcome_evaluation_end"` - `Usage BetaManagedAgentsSpanModelUsage` Token usage for a single model request. - `CacheCreationInputTokens int64` Tokens used to create prompt cache in this request. - `CacheReadInputTokens int64` Tokens read from prompt cache in this request. - `InputTokens int64` Input tokens consumed by this request. - `OutputTokens int64` Output tokens generated by this request. - `Speed BetaManagedAgentsSpanModelUsageSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsSpanModelUsageSpeedStandard BetaManagedAgentsSpanModelUsageSpeed = "standard"` - `const BetaManagedAgentsSpanModelUsageSpeedFast BetaManagedAgentsSpanModelUsageSpeed = "fast"` - `type BetaManagedAgentsSpanModelRequestStartEvent struct{…}` Emitted when a model request is initiated by the agent. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanModelRequestStartEventType` - `const BetaManagedAgentsSpanModelRequestStartEventTypeSpanModelRequestStart BetaManagedAgentsSpanModelRequestStartEventType = "span.model_request_start"` - `type BetaManagedAgentsSpanModelRequestEndEvent struct{…}` Emitted when a model request completes. - `ID string` Unique identifier for this event. - `IsError bool` Whether the model request resulted in an error. - `ModelRequestStartID string` The id of the corresponding `span.model_request_start` event. - `ModelUsage BetaManagedAgentsSpanModelUsage` Token usage for a single model request. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanModelRequestEndEventType` - `const BetaManagedAgentsSpanModelRequestEndEventTypeSpanModelRequestEnd BetaManagedAgentsSpanModelRequestEndEventType = "span.model_request_end"` - `type BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent struct{…}` Periodic heartbeat emitted while an outcome evaluation cycle is in progress. Distinguishes 'evaluation is actively running' from 'evaluation is stuck' between the corresponding `span.outcome_evaluation_start` and `span.outcome_evaluation_end` events. - `ID string` Unique identifier for this event. - `Iteration int64` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `OutcomeID string` The `outc_` ID of the outcome being evaluated. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanOutcomeEvaluationOngoingEventType` - `const BetaManagedAgentsSpanOutcomeEvaluationOngoingEventTypeSpanOutcomeEvaluationOngoing BetaManagedAgentsSpanOutcomeEvaluationOngoingEventType = "span.outcome_evaluation_ongoing"` - `type BetaManagedAgentsUserDefineOutcomeEvent struct{…}` Echo of a `user.define_outcome` input event. Carries the server-generated `outcome_id` that subsequent `span.outcome_evaluation_*` events reference. - `ID string` Unique identifier for this event. - `Description string` What the agent should produce. Copied from the input event. - `MaxIterations int64` Evaluate-then-revise cycles before giving up. Default 3, max 20. - `OutcomeID string` Server-generated `outc_` ID for this outcome. Referenced by `span.outcome_evaluation_*` events and the session's `outcome_evaluations` list. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Rubric BetaManagedAgentsUserDefineOutcomeEventRubricUnion` Rubric for grading the quality of an outcome. - `type BetaManagedAgentsFileRubric struct{…}` Rubric referenced by a file uploaded via the Files API. - `FileID string` ID of the rubric file. - `Type BetaManagedAgentsFileRubricType` - `const BetaManagedAgentsFileRubricTypeFile BetaManagedAgentsFileRubricType = "file"` - `type BetaManagedAgentsTextRubric struct{…}` Rubric content provided inline as text. - `Content string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `Type BetaManagedAgentsTextRubricType` - `const BetaManagedAgentsTextRubricTypeText BetaManagedAgentsTextRubricType = "text"` - `Type BetaManagedAgentsUserDefineOutcomeEventType` - `const BetaManagedAgentsUserDefineOutcomeEventTypeUserDefineOutcome BetaManagedAgentsUserDefineOutcomeEventType = "user.define_outcome"` - `type BetaManagedAgentsSessionDeletedEvent struct{…}` Emitted when a session has been deleted. Terminates any active event stream — no further events will be emitted for this session. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionDeletedEventType` - `const BetaManagedAgentsSessionDeletedEventTypeSessionDeleted BetaManagedAgentsSessionDeletedEventType = "session.deleted"` - `type BetaManagedAgentsSessionThreadStatusRunningEvent struct{…}` A session thread has begun executing. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that started running. - `Type BetaManagedAgentsSessionThreadStatusRunningEventType` - `const BetaManagedAgentsSessionThreadStatusRunningEventTypeSessionThreadStatusRunning BetaManagedAgentsSessionThreadStatusRunningEventType = "session.thread_status_running"` - `type BetaManagedAgentsSessionThreadStatusIdleEvent struct{…}` A session thread has yielded and is awaiting input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that went idle. - `StopReason BetaManagedAgentsSessionThreadStatusIdleEventStopReasonUnion` The agent completed its turn naturally and is ready for the next user message. - `type BetaManagedAgentsSessionEndTurn struct{…}` The agent completed its turn naturally and is ready for the next user message. - `type BetaManagedAgentsSessionRequiresAction struct{…}` The agent is idle waiting on one or more blocking user-input events (tool confirmation, custom tool result, etc.). Resolving all of them transitions the session back to running. - `type BetaManagedAgentsSessionRetriesExhausted struct{…}` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `Type BetaManagedAgentsSessionThreadStatusIdleEventType` - `const BetaManagedAgentsSessionThreadStatusIdleEventTypeSessionThreadStatusIdle BetaManagedAgentsSessionThreadStatusIdleEventType = "session.thread_status_idle"` - `type BetaManagedAgentsSessionThreadStatusTerminatedEvent struct{…}` A session thread has terminated and will accept no further input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that terminated. - `Type BetaManagedAgentsSessionThreadStatusTerminatedEventType` - `const BetaManagedAgentsSessionThreadStatusTerminatedEventTypeSessionThreadStatusTerminated BetaManagedAgentsSessionThreadStatusTerminatedEventType = "session.thread_status_terminated"` - `type BetaManagedAgentsUserToolResultEvent struct{…}` Event sent by the client providing the result of an agent-toolset tool execution. Only valid on `self_hosted` environments, where sandbox-routed tools are executed by the client rather than the server. - `ID string` Unique identifier for this event. - `ToolUseID string` The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserToolResultEventType` - `const BetaManagedAgentsUserToolResultEventTypeUserToolResult BetaManagedAgentsUserToolResultEventType = "user.tool_result"` - `Content []BetaManagedAgentsUserToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `IsError bool` Whether the tool execution resulted in an error. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Routes this result to a subagent thread. Copy from the `agent.tool_use` event's `session_thread_id`. - `type BetaManagedAgentsSessionThreadStatusRescheduledEvent struct{…}` A session thread hit a transient error and is retrying automatically. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that is retrying. - `Type BetaManagedAgentsSessionThreadStatusRescheduledEventType` - `const BetaManagedAgentsSessionThreadStatusRescheduledEventTypeSessionThreadStatusRescheduled BetaManagedAgentsSessionThreadStatusRescheduledEventType = "session.thread_status_rescheduled"` - `type BetaManagedAgentsSessionUpdatedEvent struct{…}` Emitted when an UpdateSession request changed at least one field. Carries only the fields that changed; absent fields were not part of the update. The new configuration applies from the next turn. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionUpdatedEventType` - `const BetaManagedAgentsSessionUpdatedEventTypeSessionUpdated BetaManagedAgentsSessionUpdatedEventType = "session.updated"` - `Agent BetaManagedAgentsSessionAgent` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Multiagent BetaManagedAgentsSessionMultiagentCoordinator` Resolved coordinator topology with full agent definitions for each roster member. - `Agents []BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `Name string` - `Skills []BetaManagedAgentsSessionThreadAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsSessionThreadAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsSessionThreadAgentType` - `const BetaManagedAgentsSessionThreadAgentTypeAgent BetaManagedAgentsSessionThreadAgentType = "agent"` - `Version int64` - `Type BetaManagedAgentsSessionMultiagentCoordinatorType` - `const BetaManagedAgentsSessionMultiagentCoordinatorTypeCoordinator BetaManagedAgentsSessionMultiagentCoordinatorType = "coordinator"` - `Name string` - `Skills []BetaManagedAgentsSessionAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `System string` - `Tools []BetaManagedAgentsSessionAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `type BetaManagedAgentsMCPToolset struct{…}` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Type BetaManagedAgentsSessionAgentType` - `const BetaManagedAgentsSessionAgentTypeAgent BetaManagedAgentsSessionAgentType = "agent"` - `Version int64` - `Metadata map[string, string]` The session's full metadata bag after the update. Present when the update set non-empty metadata; absent when metadata was unchanged or cleared to empty. - `Title string` The session's new title. Present only when the update changed it. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) stream := client.Beta.Sessions.Events.StreamEvents( context.TODO(), "sesn_011CZkZAtmR3yMPDzynEDxu7", anthropic.BetaSessionEventStreamParams{ }, ) for stream.Next() { fmt.Printf("%+v\n", stream.Current()) } err := stream.Err() if err != nil { panic(err.Error()) } } ``` #### Response ```json { "id": "sevt_011CZkZGOp0iBcp4kaQSihUmy", "content": [ { "text": "Where is my order #1234?", "type": "text" } ], "type": "user.message", "processed_at": "2026-03-15T10:00:00Z" } ``` ## Domain Types ### Beta Managed Agents Agent Custom Tool Use Event - `type BetaManagedAgentsAgentCustomToolUseEvent struct{…}` Event emitted when the agent calls a custom tool. The session goes idle until the client sends a `user.custom_tool_result` event with the result. - `ID string` Unique identifier for this event. - `Input map[string, any]` Input parameters for the tool call. - `Name string` Name of the custom tool being called. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentCustomToolUseEventType` - `const BetaManagedAgentsAgentCustomToolUseEventTypeAgentCustomToolUse BetaManagedAgentsAgentCustomToolUseEventType = "agent.custom_tool_use"` - `SessionThreadID string` When set, this event was cross-posted from a subagent's thread to surface its custom tool use on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.custom_tool_result` event to route the result back. ### Beta Managed Agents Agent MCP Tool Result Event - `type BetaManagedAgentsAgentMCPToolResultEvent struct{…}` Event representing the result of an MCP tool execution. - `ID string` Unique identifier for this event. - `MCPToolUseID string` The id of the `agent.mcp_tool_use` event this result corresponds to. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentMCPToolResultEventType` - `const BetaManagedAgentsAgentMCPToolResultEventTypeAgentMCPToolResult BetaManagedAgentsAgentMCPToolResultEventType = "agent.mcp_tool_result"` - `Content []BetaManagedAgentsAgentMCPToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `const BetaManagedAgentsTextBlockTypeText BetaManagedAgentsTextBlockType = "text"` - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `Source BetaManagedAgentsImageBlockSourceUnion` Union type for image source variants. - `type BetaManagedAgentsBase64ImageSource struct{…}` Base64-encoded image data. - `Data string` Base64-encoded image data. - `MediaType string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `Type BetaManagedAgentsBase64ImageSourceType` - `const BetaManagedAgentsBase64ImageSourceTypeBase64 BetaManagedAgentsBase64ImageSourceType = "base64"` - `type BetaManagedAgentsURLImageSource struct{…}` Image referenced by URL. - `Type BetaManagedAgentsURLImageSourceType` - `const BetaManagedAgentsURLImageSourceTypeURL BetaManagedAgentsURLImageSourceType = "url"` - `URL string` URL of the image to fetch. - `type BetaManagedAgentsFileImageSource struct{…}` Image referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileImageSourceType` - `const BetaManagedAgentsFileImageSourceTypeFile BetaManagedAgentsFileImageSourceType = "file"` - `Type BetaManagedAgentsImageBlockType` - `const BetaManagedAgentsImageBlockTypeImage BetaManagedAgentsImageBlockType = "image"` - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `Source BetaManagedAgentsDocumentBlockSourceUnion` Union type for document source variants. - `type BetaManagedAgentsBase64DocumentSource struct{…}` Base64-encoded document data. - `Data string` Base64-encoded document data. - `MediaType string` MIME type of the document (e.g., "application/pdf"). - `Type BetaManagedAgentsBase64DocumentSourceType` - `const BetaManagedAgentsBase64DocumentSourceTypeBase64 BetaManagedAgentsBase64DocumentSourceType = "base64"` - `type BetaManagedAgentsPlainTextDocumentSource struct{…}` Plain text document content. - `Data string` The plain text content. - `MediaType BetaManagedAgentsPlainTextDocumentSourceMediaType` MIME type of the text content. Must be "text/plain". - `const BetaManagedAgentsPlainTextDocumentSourceMediaTypeTextPlain BetaManagedAgentsPlainTextDocumentSourceMediaType = "text/plain"` - `Type BetaManagedAgentsPlainTextDocumentSourceType` - `const BetaManagedAgentsPlainTextDocumentSourceTypeText BetaManagedAgentsPlainTextDocumentSourceType = "text"` - `type BetaManagedAgentsURLDocumentSource struct{…}` Document referenced by URL. - `Type BetaManagedAgentsURLDocumentSourceType` - `const BetaManagedAgentsURLDocumentSourceTypeURL BetaManagedAgentsURLDocumentSourceType = "url"` - `URL string` URL of the document to fetch. - `type BetaManagedAgentsFileDocumentSource struct{…}` Document referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileDocumentSourceType` - `const BetaManagedAgentsFileDocumentSourceTypeFile BetaManagedAgentsFileDocumentSourceType = "file"` - `Type BetaManagedAgentsDocumentBlockType` - `const BetaManagedAgentsDocumentBlockTypeDocument BetaManagedAgentsDocumentBlockType = "document"` - `Context string` Additional context about the document for the model. - `Title string` The title of the document. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `Citations BetaManagedAgentsSearchResultCitations` Citation settings for a search result. - `Enabled bool` Whether citations are enabled for this search result. - `Content []BetaManagedAgentsSearchResultContent` Array of text content blocks from the search result. - `Text string` The text content. - `Type BetaManagedAgentsSearchResultContentType` - `const BetaManagedAgentsSearchResultContentTypeText BetaManagedAgentsSearchResultContentType = "text"` - `Source string` The URL source of the search result. - `Title string` The title of the search result. - `Type BetaManagedAgentsSearchResultBlockType` - `const BetaManagedAgentsSearchResultBlockTypeSearchResult BetaManagedAgentsSearchResultBlockType = "search_result"` - `IsError bool` Whether the tool execution resulted in an error. ### Beta Managed Agents Agent MCP Tool Use Event - `type BetaManagedAgentsAgentMCPToolUseEvent struct{…}` Event emitted when the agent invokes a tool provided by an MCP server. - `ID string` Unique identifier for this event. - `Input map[string, any]` Input parameters for the tool call. - `MCPServerName string` Name of the MCP server providing the tool. - `Name string` Name of the MCP tool being used. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentMCPToolUseEventType` - `const BetaManagedAgentsAgentMCPToolUseEventTypeAgentMCPToolUse BetaManagedAgentsAgentMCPToolUseEventType = "agent.mcp_tool_use"` - `EvaluatedPermission BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission` AgentEvaluatedPermission enum - `const BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermissionAllow BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission = "allow"` - `const BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermissionAsk BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission = "ask"` - `const BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermissionDeny BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission = "deny"` - `SessionThreadID string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. ### Beta Managed Agents Agent Message Event - `type BetaManagedAgentsAgentMessageEvent struct{…}` An agent response event in the session conversation. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsTextBlock` Array of text blocks comprising the agent response. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `const BetaManagedAgentsTextBlockTypeText BetaManagedAgentsTextBlockType = "text"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentMessageEventType` - `const BetaManagedAgentsAgentMessageEventTypeAgentMessage BetaManagedAgentsAgentMessageEventType = "agent.message"` ### Beta Managed Agents Agent Thinking Event - `type BetaManagedAgentsAgentThinkingEvent struct{…}` Indicates the agent is making forward progress via extended thinking. A progress signal, not a content carrier. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentThinkingEventType` - `const BetaManagedAgentsAgentThinkingEventTypeAgentThinking BetaManagedAgentsAgentThinkingEventType = "agent.thinking"` ### Beta Managed Agents Agent Thread Context Compacted Event - `type BetaManagedAgentsAgentThreadContextCompactedEvent struct{…}` Indicates that context compaction (summarization) occurred during the session. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentThreadContextCompactedEventType` - `const BetaManagedAgentsAgentThreadContextCompactedEventTypeAgentThreadContextCompacted BetaManagedAgentsAgentThreadContextCompactedEventType = "agent.thread_context_compacted"` ### Beta Managed Agents Agent Thread Message Received Event - `type BetaManagedAgentsAgentThreadMessageReceivedEvent struct{…}` Delivery event written to the target thread's input stream when an agent-to-agent message arrives. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsAgentThreadMessageReceivedEventContentUnion` Message content blocks. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `const BetaManagedAgentsTextBlockTypeText BetaManagedAgentsTextBlockType = "text"` - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `Source BetaManagedAgentsImageBlockSourceUnion` Union type for image source variants. - `type BetaManagedAgentsBase64ImageSource struct{…}` Base64-encoded image data. - `Data string` Base64-encoded image data. - `MediaType string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `Type BetaManagedAgentsBase64ImageSourceType` - `const BetaManagedAgentsBase64ImageSourceTypeBase64 BetaManagedAgentsBase64ImageSourceType = "base64"` - `type BetaManagedAgentsURLImageSource struct{…}` Image referenced by URL. - `Type BetaManagedAgentsURLImageSourceType` - `const BetaManagedAgentsURLImageSourceTypeURL BetaManagedAgentsURLImageSourceType = "url"` - `URL string` URL of the image to fetch. - `type BetaManagedAgentsFileImageSource struct{…}` Image referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileImageSourceType` - `const BetaManagedAgentsFileImageSourceTypeFile BetaManagedAgentsFileImageSourceType = "file"` - `Type BetaManagedAgentsImageBlockType` - `const BetaManagedAgentsImageBlockTypeImage BetaManagedAgentsImageBlockType = "image"` - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `Source BetaManagedAgentsDocumentBlockSourceUnion` Union type for document source variants. - `type BetaManagedAgentsBase64DocumentSource struct{…}` Base64-encoded document data. - `Data string` Base64-encoded document data. - `MediaType string` MIME type of the document (e.g., "application/pdf"). - `Type BetaManagedAgentsBase64DocumentSourceType` - `const BetaManagedAgentsBase64DocumentSourceTypeBase64 BetaManagedAgentsBase64DocumentSourceType = "base64"` - `type BetaManagedAgentsPlainTextDocumentSource struct{…}` Plain text document content. - `Data string` The plain text content. - `MediaType BetaManagedAgentsPlainTextDocumentSourceMediaType` MIME type of the text content. Must be "text/plain". - `const BetaManagedAgentsPlainTextDocumentSourceMediaTypeTextPlain BetaManagedAgentsPlainTextDocumentSourceMediaType = "text/plain"` - `Type BetaManagedAgentsPlainTextDocumentSourceType` - `const BetaManagedAgentsPlainTextDocumentSourceTypeText BetaManagedAgentsPlainTextDocumentSourceType = "text"` - `type BetaManagedAgentsURLDocumentSource struct{…}` Document referenced by URL. - `Type BetaManagedAgentsURLDocumentSourceType` - `const BetaManagedAgentsURLDocumentSourceTypeURL BetaManagedAgentsURLDocumentSourceType = "url"` - `URL string` URL of the document to fetch. - `type BetaManagedAgentsFileDocumentSource struct{…}` Document referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileDocumentSourceType` - `const BetaManagedAgentsFileDocumentSourceTypeFile BetaManagedAgentsFileDocumentSourceType = "file"` - `Type BetaManagedAgentsDocumentBlockType` - `const BetaManagedAgentsDocumentBlockTypeDocument BetaManagedAgentsDocumentBlockType = "document"` - `Context string` Additional context about the document for the model. - `Title string` The title of the document. - `FromSessionThreadID string` Public `sthr_` ID of the thread that sent the message. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentThreadMessageReceivedEventType` - `const BetaManagedAgentsAgentThreadMessageReceivedEventTypeAgentThreadMessageReceived BetaManagedAgentsAgentThreadMessageReceivedEventType = "agent.thread_message_received"` - `FromAgentName string` Name of the callable agent this message came from. Absent when received from the primary agent. ### Beta Managed Agents Agent Thread Message Sent Event - `type BetaManagedAgentsAgentThreadMessageSentEvent struct{…}` Observability event emitted to the sender's output stream when an agent-to-agent message is sent. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsAgentThreadMessageSentEventContentUnion` Message content blocks. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `const BetaManagedAgentsTextBlockTypeText BetaManagedAgentsTextBlockType = "text"` - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `Source BetaManagedAgentsImageBlockSourceUnion` Union type for image source variants. - `type BetaManagedAgentsBase64ImageSource struct{…}` Base64-encoded image data. - `Data string` Base64-encoded image data. - `MediaType string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `Type BetaManagedAgentsBase64ImageSourceType` - `const BetaManagedAgentsBase64ImageSourceTypeBase64 BetaManagedAgentsBase64ImageSourceType = "base64"` - `type BetaManagedAgentsURLImageSource struct{…}` Image referenced by URL. - `Type BetaManagedAgentsURLImageSourceType` - `const BetaManagedAgentsURLImageSourceTypeURL BetaManagedAgentsURLImageSourceType = "url"` - `URL string` URL of the image to fetch. - `type BetaManagedAgentsFileImageSource struct{…}` Image referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileImageSourceType` - `const BetaManagedAgentsFileImageSourceTypeFile BetaManagedAgentsFileImageSourceType = "file"` - `Type BetaManagedAgentsImageBlockType` - `const BetaManagedAgentsImageBlockTypeImage BetaManagedAgentsImageBlockType = "image"` - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `Source BetaManagedAgentsDocumentBlockSourceUnion` Union type for document source variants. - `type BetaManagedAgentsBase64DocumentSource struct{…}` Base64-encoded document data. - `Data string` Base64-encoded document data. - `MediaType string` MIME type of the document (e.g., "application/pdf"). - `Type BetaManagedAgentsBase64DocumentSourceType` - `const BetaManagedAgentsBase64DocumentSourceTypeBase64 BetaManagedAgentsBase64DocumentSourceType = "base64"` - `type BetaManagedAgentsPlainTextDocumentSource struct{…}` Plain text document content. - `Data string` The plain text content. - `MediaType BetaManagedAgentsPlainTextDocumentSourceMediaType` MIME type of the text content. Must be "text/plain". - `const BetaManagedAgentsPlainTextDocumentSourceMediaTypeTextPlain BetaManagedAgentsPlainTextDocumentSourceMediaType = "text/plain"` - `Type BetaManagedAgentsPlainTextDocumentSourceType` - `const BetaManagedAgentsPlainTextDocumentSourceTypeText BetaManagedAgentsPlainTextDocumentSourceType = "text"` - `type BetaManagedAgentsURLDocumentSource struct{…}` Document referenced by URL. - `Type BetaManagedAgentsURLDocumentSourceType` - `const BetaManagedAgentsURLDocumentSourceTypeURL BetaManagedAgentsURLDocumentSourceType = "url"` - `URL string` URL of the document to fetch. - `type BetaManagedAgentsFileDocumentSource struct{…}` Document referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileDocumentSourceType` - `const BetaManagedAgentsFileDocumentSourceTypeFile BetaManagedAgentsFileDocumentSourceType = "file"` - `Type BetaManagedAgentsDocumentBlockType` - `const BetaManagedAgentsDocumentBlockTypeDocument BetaManagedAgentsDocumentBlockType = "document"` - `Context string` Additional context about the document for the model. - `Title string` The title of the document. - `ProcessedAt Time` A timestamp in RFC 3339 format - `ToSessionThreadID string` Public `sthr_` ID of the thread the message was sent to. - `Type BetaManagedAgentsAgentThreadMessageSentEventType` - `const BetaManagedAgentsAgentThreadMessageSentEventTypeAgentThreadMessageSent BetaManagedAgentsAgentThreadMessageSentEventType = "agent.thread_message_sent"` - `ToAgentName string` Name of the callable agent this message was sent to. Absent when sent to the primary agent. ### Beta Managed Agents Agent Tool Result Event - `type BetaManagedAgentsAgentToolResultEvent struct{…}` Event representing the result of an agent tool execution. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `ToolUseID string` The id of the `agent.tool_use` event this result corresponds to. - `Type BetaManagedAgentsAgentToolResultEventType` - `const BetaManagedAgentsAgentToolResultEventTypeAgentToolResult BetaManagedAgentsAgentToolResultEventType = "agent.tool_result"` - `Content []BetaManagedAgentsAgentToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `const BetaManagedAgentsTextBlockTypeText BetaManagedAgentsTextBlockType = "text"` - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `Source BetaManagedAgentsImageBlockSourceUnion` Union type for image source variants. - `type BetaManagedAgentsBase64ImageSource struct{…}` Base64-encoded image data. - `Data string` Base64-encoded image data. - `MediaType string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `Type BetaManagedAgentsBase64ImageSourceType` - `const BetaManagedAgentsBase64ImageSourceTypeBase64 BetaManagedAgentsBase64ImageSourceType = "base64"` - `type BetaManagedAgentsURLImageSource struct{…}` Image referenced by URL. - `Type BetaManagedAgentsURLImageSourceType` - `const BetaManagedAgentsURLImageSourceTypeURL BetaManagedAgentsURLImageSourceType = "url"` - `URL string` URL of the image to fetch. - `type BetaManagedAgentsFileImageSource struct{…}` Image referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileImageSourceType` - `const BetaManagedAgentsFileImageSourceTypeFile BetaManagedAgentsFileImageSourceType = "file"` - `Type BetaManagedAgentsImageBlockType` - `const BetaManagedAgentsImageBlockTypeImage BetaManagedAgentsImageBlockType = "image"` - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `Source BetaManagedAgentsDocumentBlockSourceUnion` Union type for document source variants. - `type BetaManagedAgentsBase64DocumentSource struct{…}` Base64-encoded document data. - `Data string` Base64-encoded document data. - `MediaType string` MIME type of the document (e.g., "application/pdf"). - `Type BetaManagedAgentsBase64DocumentSourceType` - `const BetaManagedAgentsBase64DocumentSourceTypeBase64 BetaManagedAgentsBase64DocumentSourceType = "base64"` - `type BetaManagedAgentsPlainTextDocumentSource struct{…}` Plain text document content. - `Data string` The plain text content. - `MediaType BetaManagedAgentsPlainTextDocumentSourceMediaType` MIME type of the text content. Must be "text/plain". - `const BetaManagedAgentsPlainTextDocumentSourceMediaTypeTextPlain BetaManagedAgentsPlainTextDocumentSourceMediaType = "text/plain"` - `Type BetaManagedAgentsPlainTextDocumentSourceType` - `const BetaManagedAgentsPlainTextDocumentSourceTypeText BetaManagedAgentsPlainTextDocumentSourceType = "text"` - `type BetaManagedAgentsURLDocumentSource struct{…}` Document referenced by URL. - `Type BetaManagedAgentsURLDocumentSourceType` - `const BetaManagedAgentsURLDocumentSourceTypeURL BetaManagedAgentsURLDocumentSourceType = "url"` - `URL string` URL of the document to fetch. - `type BetaManagedAgentsFileDocumentSource struct{…}` Document referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileDocumentSourceType` - `const BetaManagedAgentsFileDocumentSourceTypeFile BetaManagedAgentsFileDocumentSourceType = "file"` - `Type BetaManagedAgentsDocumentBlockType` - `const BetaManagedAgentsDocumentBlockTypeDocument BetaManagedAgentsDocumentBlockType = "document"` - `Context string` Additional context about the document for the model. - `Title string` The title of the document. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `Citations BetaManagedAgentsSearchResultCitations` Citation settings for a search result. - `Enabled bool` Whether citations are enabled for this search result. - `Content []BetaManagedAgentsSearchResultContent` Array of text content blocks from the search result. - `Text string` The text content. - `Type BetaManagedAgentsSearchResultContentType` - `const BetaManagedAgentsSearchResultContentTypeText BetaManagedAgentsSearchResultContentType = "text"` - `Source string` The URL source of the search result. - `Title string` The title of the search result. - `Type BetaManagedAgentsSearchResultBlockType` - `const BetaManagedAgentsSearchResultBlockTypeSearchResult BetaManagedAgentsSearchResultBlockType = "search_result"` - `IsError bool` Whether the tool execution resulted in an error. ### Beta Managed Agents Agent Tool Use Event - `type BetaManagedAgentsAgentToolUseEvent struct{…}` Event emitted when the agent invokes a built-in agent tool. - `ID string` Unique identifier for this event. - `Input map[string, any]` Input parameters for the tool call. - `Name string` Name of the agent tool being used. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentToolUseEventType` - `const BetaManagedAgentsAgentToolUseEventTypeAgentToolUse BetaManagedAgentsAgentToolUseEventType = "agent.tool_use"` - `EvaluatedPermission BetaManagedAgentsAgentToolUseEventEvaluatedPermission` AgentEvaluatedPermission enum - `const BetaManagedAgentsAgentToolUseEventEvaluatedPermissionAllow BetaManagedAgentsAgentToolUseEventEvaluatedPermission = "allow"` - `const BetaManagedAgentsAgentToolUseEventEvaluatedPermissionAsk BetaManagedAgentsAgentToolUseEventEvaluatedPermission = "ask"` - `const BetaManagedAgentsAgentToolUseEventEvaluatedPermissionDeny BetaManagedAgentsAgentToolUseEventEvaluatedPermission = "deny"` - `SessionThreadID string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. ### Beta Managed Agents Base64 Document Source - `type BetaManagedAgentsBase64DocumentSource struct{…}` Base64-encoded document data. - `Data string` Base64-encoded document data. - `MediaType string` MIME type of the document (e.g., "application/pdf"). - `Type BetaManagedAgentsBase64DocumentSourceType` - `const BetaManagedAgentsBase64DocumentSourceTypeBase64 BetaManagedAgentsBase64DocumentSourceType = "base64"` ### Beta Managed Agents Base64 Image Source - `type BetaManagedAgentsBase64ImageSource struct{…}` Base64-encoded image data. - `Data string` Base64-encoded image data. - `MediaType string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `Type BetaManagedAgentsBase64ImageSourceType` - `const BetaManagedAgentsBase64ImageSourceTypeBase64 BetaManagedAgentsBase64ImageSourceType = "base64"` ### Beta Managed Agents Billing Error - `type BetaManagedAgentsBillingError struct{…}` The caller's organization or workspace cannot make model requests — out of credits or spend limit reached. Retrying with the same credentials will not succeed; the caller must resolve the billing state. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsBillingErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `Type BetaManagedAgentsRetryStatusRetryingType` - `const BetaManagedAgentsRetryStatusRetryingTypeRetrying BetaManagedAgentsRetryStatusRetryingType = "retrying"` - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `Type BetaManagedAgentsRetryStatusExhaustedType` - `const BetaManagedAgentsRetryStatusExhaustedTypeExhausted BetaManagedAgentsRetryStatusExhaustedType = "exhausted"` - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsRetryStatusTerminalType` - `const BetaManagedAgentsRetryStatusTerminalTypeTerminal BetaManagedAgentsRetryStatusTerminalType = "terminal"` - `Type BetaManagedAgentsBillingErrorType` - `const BetaManagedAgentsBillingErrorTypeBillingError BetaManagedAgentsBillingErrorType = "billing_error"` ### Beta Managed Agents Document Block - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `Source BetaManagedAgentsDocumentBlockSourceUnion` Union type for document source variants. - `type BetaManagedAgentsBase64DocumentSource struct{…}` Base64-encoded document data. - `Data string` Base64-encoded document data. - `MediaType string` MIME type of the document (e.g., "application/pdf"). - `Type BetaManagedAgentsBase64DocumentSourceType` - `const BetaManagedAgentsBase64DocumentSourceTypeBase64 BetaManagedAgentsBase64DocumentSourceType = "base64"` - `type BetaManagedAgentsPlainTextDocumentSource struct{…}` Plain text document content. - `Data string` The plain text content. - `MediaType BetaManagedAgentsPlainTextDocumentSourceMediaType` MIME type of the text content. Must be "text/plain". - `const BetaManagedAgentsPlainTextDocumentSourceMediaTypeTextPlain BetaManagedAgentsPlainTextDocumentSourceMediaType = "text/plain"` - `Type BetaManagedAgentsPlainTextDocumentSourceType` - `const BetaManagedAgentsPlainTextDocumentSourceTypeText BetaManagedAgentsPlainTextDocumentSourceType = "text"` - `type BetaManagedAgentsURLDocumentSource struct{…}` Document referenced by URL. - `Type BetaManagedAgentsURLDocumentSourceType` - `const BetaManagedAgentsURLDocumentSourceTypeURL BetaManagedAgentsURLDocumentSourceType = "url"` - `URL string` URL of the document to fetch. - `type BetaManagedAgentsFileDocumentSource struct{…}` Document referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileDocumentSourceType` - `const BetaManagedAgentsFileDocumentSourceTypeFile BetaManagedAgentsFileDocumentSourceType = "file"` - `Type BetaManagedAgentsDocumentBlockType` - `const BetaManagedAgentsDocumentBlockTypeDocument BetaManagedAgentsDocumentBlockType = "document"` - `Context string` Additional context about the document for the model. - `Title string` The title of the document. ### Beta Managed Agents Event Params - `type BetaManagedAgentsEventParamsUnionResp interface{…}` Union type for event parameters that can be sent to a session. - `type BetaManagedAgentsUserMessageEventParamsResp struct{…}` Parameters for sending a user message to the session. - `Content []BetaManagedAgentsUserMessageEventParamsContentUnionResp` Array of content blocks for the user message. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `const BetaManagedAgentsTextBlockTypeText BetaManagedAgentsTextBlockType = "text"` - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `Source BetaManagedAgentsImageBlockSourceUnion` Union type for image source variants. - `type BetaManagedAgentsBase64ImageSource struct{…}` Base64-encoded image data. - `Data string` Base64-encoded image data. - `MediaType string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `Type BetaManagedAgentsBase64ImageSourceType` - `const BetaManagedAgentsBase64ImageSourceTypeBase64 BetaManagedAgentsBase64ImageSourceType = "base64"` - `type BetaManagedAgentsURLImageSource struct{…}` Image referenced by URL. - `Type BetaManagedAgentsURLImageSourceType` - `const BetaManagedAgentsURLImageSourceTypeURL BetaManagedAgentsURLImageSourceType = "url"` - `URL string` URL of the image to fetch. - `type BetaManagedAgentsFileImageSource struct{…}` Image referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileImageSourceType` - `const BetaManagedAgentsFileImageSourceTypeFile BetaManagedAgentsFileImageSourceType = "file"` - `Type BetaManagedAgentsImageBlockType` - `const BetaManagedAgentsImageBlockTypeImage BetaManagedAgentsImageBlockType = "image"` - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `Source BetaManagedAgentsDocumentBlockSourceUnion` Union type for document source variants. - `type BetaManagedAgentsBase64DocumentSource struct{…}` Base64-encoded document data. - `Data string` Base64-encoded document data. - `MediaType string` MIME type of the document (e.g., "application/pdf"). - `Type BetaManagedAgentsBase64DocumentSourceType` - `const BetaManagedAgentsBase64DocumentSourceTypeBase64 BetaManagedAgentsBase64DocumentSourceType = "base64"` - `type BetaManagedAgentsPlainTextDocumentSource struct{…}` Plain text document content. - `Data string` The plain text content. - `MediaType BetaManagedAgentsPlainTextDocumentSourceMediaType` MIME type of the text content. Must be "text/plain". - `const BetaManagedAgentsPlainTextDocumentSourceMediaTypeTextPlain BetaManagedAgentsPlainTextDocumentSourceMediaType = "text/plain"` - `Type BetaManagedAgentsPlainTextDocumentSourceType` - `const BetaManagedAgentsPlainTextDocumentSourceTypeText BetaManagedAgentsPlainTextDocumentSourceType = "text"` - `type BetaManagedAgentsURLDocumentSource struct{…}` Document referenced by URL. - `Type BetaManagedAgentsURLDocumentSourceType` - `const BetaManagedAgentsURLDocumentSourceTypeURL BetaManagedAgentsURLDocumentSourceType = "url"` - `URL string` URL of the document to fetch. - `type BetaManagedAgentsFileDocumentSource struct{…}` Document referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileDocumentSourceType` - `const BetaManagedAgentsFileDocumentSourceTypeFile BetaManagedAgentsFileDocumentSourceType = "file"` - `Type BetaManagedAgentsDocumentBlockType` - `const BetaManagedAgentsDocumentBlockTypeDocument BetaManagedAgentsDocumentBlockType = "document"` - `Context string` Additional context about the document for the model. - `Title string` The title of the document. - `Type BetaManagedAgentsUserMessageEventParamsType` - `const BetaManagedAgentsUserMessageEventParamsTypeUserMessage BetaManagedAgentsUserMessageEventParamsType = "user.message"` - `type BetaManagedAgentsUserInterruptEventParamsResp struct{…}` Parameters for sending an interrupt to pause the agent. - `Type BetaManagedAgentsUserInterruptEventParamsType` - `const BetaManagedAgentsUserInterruptEventParamsTypeUserInterrupt BetaManagedAgentsUserInterruptEventParamsType = "user.interrupt"` - `SessionThreadID string` If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. - `type BetaManagedAgentsUserToolConfirmationEventParamsResp struct{…}` Parameters for confirming or denying a tool execution request. - `Result BetaManagedAgentsUserToolConfirmationEventParamsResult` UserToolConfirmationResult enum - `const BetaManagedAgentsUserToolConfirmationEventParamsResultAllow BetaManagedAgentsUserToolConfirmationEventParamsResult = "allow"` - `const BetaManagedAgentsUserToolConfirmationEventParamsResultDeny BetaManagedAgentsUserToolConfirmationEventParamsResult = "deny"` - `ToolUseID string` The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserToolConfirmationEventParamsType` - `const BetaManagedAgentsUserToolConfirmationEventParamsTypeUserToolConfirmation BetaManagedAgentsUserToolConfirmationEventParamsType = "user.tool_confirmation"` - `DenyMessage string` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. - `type BetaManagedAgentsUserCustomToolResultEventParamsResp struct{…}` Parameters for providing the result of a custom tool execution. - `CustomToolUseID string` The id of the `agent.custom_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserCustomToolResultEventParamsType` - `const BetaManagedAgentsUserCustomToolResultEventParamsTypeUserCustomToolResult BetaManagedAgentsUserCustomToolResultEventParamsType = "user.custom_tool_result"` - `Content []BetaManagedAgentsUserCustomToolResultEventParamsContentUnionResp` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `Citations BetaManagedAgentsSearchResultCitations` Citation settings for a search result. - `Enabled bool` Whether citations are enabled for this search result. - `Content []BetaManagedAgentsSearchResultContent` Array of text content blocks from the search result. - `Text string` The text content. - `Type BetaManagedAgentsSearchResultContentType` - `const BetaManagedAgentsSearchResultContentTypeText BetaManagedAgentsSearchResultContentType = "text"` - `Source string` The URL source of the search result. - `Title string` The title of the search result. - `Type BetaManagedAgentsSearchResultBlockType` - `const BetaManagedAgentsSearchResultBlockTypeSearchResult BetaManagedAgentsSearchResultBlockType = "search_result"` - `IsError bool` Whether the tool execution resulted in an error. - `type BetaManagedAgentsUserDefineOutcomeEventParamsResp struct{…}` Parameters for defining an outcome the agent should work toward. The agent begins work on receipt. - `Description string` What the agent should produce. This is the task specification. - `Rubric BetaManagedAgentsUserDefineOutcomeEventParamsRubricUnionResp` Rubric for grading the quality of an outcome. - `type BetaManagedAgentsFileRubricParamsResp struct{…}` Rubric referenced by a file uploaded via the Files API. - `FileID string` ID of the rubric file. - `Type BetaManagedAgentsFileRubricParamsType` - `const BetaManagedAgentsFileRubricParamsTypeFile BetaManagedAgentsFileRubricParamsType = "file"` - `type BetaManagedAgentsTextRubricParamsResp struct{…}` Rubric content provided inline as text. - `Content string` Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters. - `Type BetaManagedAgentsTextRubricParamsType` - `const BetaManagedAgentsTextRubricParamsTypeText BetaManagedAgentsTextRubricParamsType = "text"` - `Type BetaManagedAgentsUserDefineOutcomeEventParamsType` - `const BetaManagedAgentsUserDefineOutcomeEventParamsTypeUserDefineOutcome BetaManagedAgentsUserDefineOutcomeEventParamsType = "user.define_outcome"` - `MaxIterations int64` Eval→revision cycles before giving up. Default 3, max 20. - `type BetaManagedAgentsUserToolResultEventParamsResp struct{…}` Parameters for providing the result of an agent-toolset tool execution. Only valid on `self_hosted` environments, where sandbox-routed tools are executed by the client rather than the server. - `ToolUseID string` The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserToolResultEventParamsType` - `const BetaManagedAgentsUserToolResultEventParamsTypeUserToolResult BetaManagedAgentsUserToolResultEventParamsType = "user.tool_result"` - `Content []BetaManagedAgentsUserToolResultEventParamsContentUnionResp` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `IsError bool` Whether the tool execution resulted in an error. ### Beta Managed Agents File Document Source - `type BetaManagedAgentsFileDocumentSource struct{…}` Document referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileDocumentSourceType` - `const BetaManagedAgentsFileDocumentSourceTypeFile BetaManagedAgentsFileDocumentSourceType = "file"` ### Beta Managed Agents File Image Source - `type BetaManagedAgentsFileImageSource struct{…}` Image referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileImageSourceType` - `const BetaManagedAgentsFileImageSourceTypeFile BetaManagedAgentsFileImageSourceType = "file"` ### Beta Managed Agents File Rubric - `type BetaManagedAgentsFileRubric struct{…}` Rubric referenced by a file uploaded via the Files API. - `FileID string` ID of the rubric file. - `Type BetaManagedAgentsFileRubricType` - `const BetaManagedAgentsFileRubricTypeFile BetaManagedAgentsFileRubricType = "file"` ### Beta Managed Agents File Rubric Params - `type BetaManagedAgentsFileRubricParamsResp struct{…}` Rubric referenced by a file uploaded via the Files API. - `FileID string` ID of the rubric file. - `Type BetaManagedAgentsFileRubricParamsType` - `const BetaManagedAgentsFileRubricParamsTypeFile BetaManagedAgentsFileRubricParamsType = "file"` ### Beta Managed Agents Image Block - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `Source BetaManagedAgentsImageBlockSourceUnion` Union type for image source variants. - `type BetaManagedAgentsBase64ImageSource struct{…}` Base64-encoded image data. - `Data string` Base64-encoded image data. - `MediaType string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `Type BetaManagedAgentsBase64ImageSourceType` - `const BetaManagedAgentsBase64ImageSourceTypeBase64 BetaManagedAgentsBase64ImageSourceType = "base64"` - `type BetaManagedAgentsURLImageSource struct{…}` Image referenced by URL. - `Type BetaManagedAgentsURLImageSourceType` - `const BetaManagedAgentsURLImageSourceTypeURL BetaManagedAgentsURLImageSourceType = "url"` - `URL string` URL of the image to fetch. - `type BetaManagedAgentsFileImageSource struct{…}` Image referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileImageSourceType` - `const BetaManagedAgentsFileImageSourceTypeFile BetaManagedAgentsFileImageSourceType = "file"` - `Type BetaManagedAgentsImageBlockType` - `const BetaManagedAgentsImageBlockTypeImage BetaManagedAgentsImageBlockType = "image"` ### Beta Managed Agents MCP Authentication Failed Error - `type BetaManagedAgentsMCPAuthenticationFailedError struct{…}` Authentication to an MCP server failed. - `MCPServerName string` Name of the MCP server that failed authentication. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsMCPAuthenticationFailedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `Type BetaManagedAgentsRetryStatusRetryingType` - `const BetaManagedAgentsRetryStatusRetryingTypeRetrying BetaManagedAgentsRetryStatusRetryingType = "retrying"` - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `Type BetaManagedAgentsRetryStatusExhaustedType` - `const BetaManagedAgentsRetryStatusExhaustedTypeExhausted BetaManagedAgentsRetryStatusExhaustedType = "exhausted"` - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsRetryStatusTerminalType` - `const BetaManagedAgentsRetryStatusTerminalTypeTerminal BetaManagedAgentsRetryStatusTerminalType = "terminal"` - `Type BetaManagedAgentsMCPAuthenticationFailedErrorType` - `const BetaManagedAgentsMCPAuthenticationFailedErrorTypeMCPAuthenticationFailedError BetaManagedAgentsMCPAuthenticationFailedErrorType = "mcp_authentication_failed_error"` ### Beta Managed Agents MCP Connection Failed Error - `type BetaManagedAgentsMCPConnectionFailedError struct{…}` Failed to connect to an MCP server. - `MCPServerName string` Name of the MCP server that failed to connect. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsMCPConnectionFailedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `Type BetaManagedAgentsRetryStatusRetryingType` - `const BetaManagedAgentsRetryStatusRetryingTypeRetrying BetaManagedAgentsRetryStatusRetryingType = "retrying"` - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `Type BetaManagedAgentsRetryStatusExhaustedType` - `const BetaManagedAgentsRetryStatusExhaustedTypeExhausted BetaManagedAgentsRetryStatusExhaustedType = "exhausted"` - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsRetryStatusTerminalType` - `const BetaManagedAgentsRetryStatusTerminalTypeTerminal BetaManagedAgentsRetryStatusTerminalType = "terminal"` - `Type BetaManagedAgentsMCPConnectionFailedErrorType` - `const BetaManagedAgentsMCPConnectionFailedErrorTypeMCPConnectionFailedError BetaManagedAgentsMCPConnectionFailedErrorType = "mcp_connection_failed_error"` ### Beta Managed Agents Model Overloaded Error - `type BetaManagedAgentsModelOverloadedError struct{…}` The model is currently overloaded. Emitted after automatic retries are exhausted. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsModelOverloadedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `Type BetaManagedAgentsRetryStatusRetryingType` - `const BetaManagedAgentsRetryStatusRetryingTypeRetrying BetaManagedAgentsRetryStatusRetryingType = "retrying"` - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `Type BetaManagedAgentsRetryStatusExhaustedType` - `const BetaManagedAgentsRetryStatusExhaustedTypeExhausted BetaManagedAgentsRetryStatusExhaustedType = "exhausted"` - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsRetryStatusTerminalType` - `const BetaManagedAgentsRetryStatusTerminalTypeTerminal BetaManagedAgentsRetryStatusTerminalType = "terminal"` - `Type BetaManagedAgentsModelOverloadedErrorType` - `const BetaManagedAgentsModelOverloadedErrorTypeModelOverloadedError BetaManagedAgentsModelOverloadedErrorType = "model_overloaded_error"` ### Beta Managed Agents Model Rate Limited Error - `type BetaManagedAgentsModelRateLimitedError struct{…}` The model request was rate-limited. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsModelRateLimitedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `Type BetaManagedAgentsRetryStatusRetryingType` - `const BetaManagedAgentsRetryStatusRetryingTypeRetrying BetaManagedAgentsRetryStatusRetryingType = "retrying"` - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `Type BetaManagedAgentsRetryStatusExhaustedType` - `const BetaManagedAgentsRetryStatusExhaustedTypeExhausted BetaManagedAgentsRetryStatusExhaustedType = "exhausted"` - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsRetryStatusTerminalType` - `const BetaManagedAgentsRetryStatusTerminalTypeTerminal BetaManagedAgentsRetryStatusTerminalType = "terminal"` - `Type BetaManagedAgentsModelRateLimitedErrorType` - `const BetaManagedAgentsModelRateLimitedErrorTypeModelRateLimitedError BetaManagedAgentsModelRateLimitedErrorType = "model_rate_limited_error"` ### Beta Managed Agents Model Request Failed Error - `type BetaManagedAgentsModelRequestFailedError struct{…}` A model request failed for a reason other than overload or rate-limiting. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsModelRequestFailedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `Type BetaManagedAgentsRetryStatusRetryingType` - `const BetaManagedAgentsRetryStatusRetryingTypeRetrying BetaManagedAgentsRetryStatusRetryingType = "retrying"` - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `Type BetaManagedAgentsRetryStatusExhaustedType` - `const BetaManagedAgentsRetryStatusExhaustedTypeExhausted BetaManagedAgentsRetryStatusExhaustedType = "exhausted"` - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsRetryStatusTerminalType` - `const BetaManagedAgentsRetryStatusTerminalTypeTerminal BetaManagedAgentsRetryStatusTerminalType = "terminal"` - `Type BetaManagedAgentsModelRequestFailedErrorType` - `const BetaManagedAgentsModelRequestFailedErrorTypeModelRequestFailedError BetaManagedAgentsModelRequestFailedErrorType = "model_request_failed_error"` ### Beta Managed Agents Plain Text Document Source - `type BetaManagedAgentsPlainTextDocumentSource struct{…}` Plain text document content. - `Data string` The plain text content. - `MediaType BetaManagedAgentsPlainTextDocumentSourceMediaType` MIME type of the text content. Must be "text/plain". - `const BetaManagedAgentsPlainTextDocumentSourceMediaTypeTextPlain BetaManagedAgentsPlainTextDocumentSourceMediaType = "text/plain"` - `Type BetaManagedAgentsPlainTextDocumentSourceType` - `const BetaManagedAgentsPlainTextDocumentSourceTypeText BetaManagedAgentsPlainTextDocumentSourceType = "text"` ### Beta Managed Agents Retry Status Exhausted - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `Type BetaManagedAgentsRetryStatusExhaustedType` - `const BetaManagedAgentsRetryStatusExhaustedTypeExhausted BetaManagedAgentsRetryStatusExhaustedType = "exhausted"` ### Beta Managed Agents Retry Status Retrying - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `Type BetaManagedAgentsRetryStatusRetryingType` - `const BetaManagedAgentsRetryStatusRetryingTypeRetrying BetaManagedAgentsRetryStatusRetryingType = "retrying"` ### Beta Managed Agents Retry Status Terminal - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsRetryStatusTerminalType` - `const BetaManagedAgentsRetryStatusTerminalTypeTerminal BetaManagedAgentsRetryStatusTerminalType = "terminal"` ### Beta Managed Agents Search Result Block - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `Citations BetaManagedAgentsSearchResultCitations` Citation settings for a search result. - `Enabled bool` Whether citations are enabled for this search result. - `Content []BetaManagedAgentsSearchResultContent` Array of text content blocks from the search result. - `Text string` The text content. - `Type BetaManagedAgentsSearchResultContentType` - `const BetaManagedAgentsSearchResultContentTypeText BetaManagedAgentsSearchResultContentType = "text"` - `Source string` The URL source of the search result. - `Title string` The title of the search result. - `Type BetaManagedAgentsSearchResultBlockType` - `const BetaManagedAgentsSearchResultBlockTypeSearchResult BetaManagedAgentsSearchResultBlockType = "search_result"` ### Beta Managed Agents Search Result Citations - `type BetaManagedAgentsSearchResultCitations struct{…}` Citation settings for a search result. - `Enabled bool` Whether citations are enabled for this search result. ### Beta Managed Agents Search Result Content - `type BetaManagedAgentsSearchResultContent struct{…}` Text content within a search result. - `Text string` The text content. - `Type BetaManagedAgentsSearchResultContentType` - `const BetaManagedAgentsSearchResultContentTypeText BetaManagedAgentsSearchResultContentType = "text"` ### Beta Managed Agents Send Session Events - `type BetaManagedAgentsSendSessionEvents struct{…}` Events that were successfully sent to the session. - `Data []BetaManagedAgentsSendSessionEventsDataUnion` Sent events - `type BetaManagedAgentsUserMessageEvent struct{…}` A user message event in the session conversation. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsUserMessageEventContentUnion` Array of content blocks comprising the user message. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `const BetaManagedAgentsTextBlockTypeText BetaManagedAgentsTextBlockType = "text"` - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `Source BetaManagedAgentsImageBlockSourceUnion` Union type for image source variants. - `type BetaManagedAgentsBase64ImageSource struct{…}` Base64-encoded image data. - `Data string` Base64-encoded image data. - `MediaType string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `Type BetaManagedAgentsBase64ImageSourceType` - `const BetaManagedAgentsBase64ImageSourceTypeBase64 BetaManagedAgentsBase64ImageSourceType = "base64"` - `type BetaManagedAgentsURLImageSource struct{…}` Image referenced by URL. - `Type BetaManagedAgentsURLImageSourceType` - `const BetaManagedAgentsURLImageSourceTypeURL BetaManagedAgentsURLImageSourceType = "url"` - `URL string` URL of the image to fetch. - `type BetaManagedAgentsFileImageSource struct{…}` Image referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileImageSourceType` - `const BetaManagedAgentsFileImageSourceTypeFile BetaManagedAgentsFileImageSourceType = "file"` - `Type BetaManagedAgentsImageBlockType` - `const BetaManagedAgentsImageBlockTypeImage BetaManagedAgentsImageBlockType = "image"` - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `Source BetaManagedAgentsDocumentBlockSourceUnion` Union type for document source variants. - `type BetaManagedAgentsBase64DocumentSource struct{…}` Base64-encoded document data. - `Data string` Base64-encoded document data. - `MediaType string` MIME type of the document (e.g., "application/pdf"). - `Type BetaManagedAgentsBase64DocumentSourceType` - `const BetaManagedAgentsBase64DocumentSourceTypeBase64 BetaManagedAgentsBase64DocumentSourceType = "base64"` - `type BetaManagedAgentsPlainTextDocumentSource struct{…}` Plain text document content. - `Data string` The plain text content. - `MediaType BetaManagedAgentsPlainTextDocumentSourceMediaType` MIME type of the text content. Must be "text/plain". - `const BetaManagedAgentsPlainTextDocumentSourceMediaTypeTextPlain BetaManagedAgentsPlainTextDocumentSourceMediaType = "text/plain"` - `Type BetaManagedAgentsPlainTextDocumentSourceType` - `const BetaManagedAgentsPlainTextDocumentSourceTypeText BetaManagedAgentsPlainTextDocumentSourceType = "text"` - `type BetaManagedAgentsURLDocumentSource struct{…}` Document referenced by URL. - `Type BetaManagedAgentsURLDocumentSourceType` - `const BetaManagedAgentsURLDocumentSourceTypeURL BetaManagedAgentsURLDocumentSourceType = "url"` - `URL string` URL of the document to fetch. - `type BetaManagedAgentsFileDocumentSource struct{…}` Document referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileDocumentSourceType` - `const BetaManagedAgentsFileDocumentSourceTypeFile BetaManagedAgentsFileDocumentSourceType = "file"` - `Type BetaManagedAgentsDocumentBlockType` - `const BetaManagedAgentsDocumentBlockTypeDocument BetaManagedAgentsDocumentBlockType = "document"` - `Context string` Additional context about the document for the model. - `Title string` The title of the document. - `Type BetaManagedAgentsUserMessageEventType` - `const BetaManagedAgentsUserMessageEventTypeUserMessage BetaManagedAgentsUserMessageEventType = "user.message"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `type BetaManagedAgentsUserInterruptEvent struct{…}` An interrupt event that pauses agent execution and returns control to the user. - `ID string` Unique identifier for this event. - `Type BetaManagedAgentsUserInterruptEventType` - `const BetaManagedAgentsUserInterruptEventTypeUserInterrupt BetaManagedAgentsUserInterruptEventType = "user.interrupt"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. - `type BetaManagedAgentsUserToolConfirmationEvent struct{…}` A tool confirmation event that approves or denies a pending tool execution. - `ID string` Unique identifier for this event. - `Result BetaManagedAgentsUserToolConfirmationEventResult` UserToolConfirmationResult enum - `const BetaManagedAgentsUserToolConfirmationEventResultAllow BetaManagedAgentsUserToolConfirmationEventResult = "allow"` - `const BetaManagedAgentsUserToolConfirmationEventResultDeny BetaManagedAgentsUserToolConfirmationEventResult = "deny"` - `ToolUseID string` The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserToolConfirmationEventType` - `const BetaManagedAgentsUserToolConfirmationEventTypeUserToolConfirmation BetaManagedAgentsUserToolConfirmationEventType = "user.tool_confirmation"` - `DenyMessage string` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` When set, the confirmation routes to this subagent's thread rather than the primary. Echo this from the `session_thread_id` on the `agent.tool_use` or `agent.mcp_tool_use` event that prompted the approval. - `type BetaManagedAgentsUserCustomToolResultEvent struct{…}` Event sent by the client providing the result of a custom tool execution. - `ID string` Unique identifier for this event. - `CustomToolUseID string` The id of the `agent.custom_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserCustomToolResultEventType` - `const BetaManagedAgentsUserCustomToolResultEventTypeUserCustomToolResult BetaManagedAgentsUserCustomToolResultEventType = "user.custom_tool_result"` - `Content []BetaManagedAgentsUserCustomToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `Citations BetaManagedAgentsSearchResultCitations` Citation settings for a search result. - `Enabled bool` Whether citations are enabled for this search result. - `Content []BetaManagedAgentsSearchResultContent` Array of text content blocks from the search result. - `Text string` The text content. - `Type BetaManagedAgentsSearchResultContentType` - `const BetaManagedAgentsSearchResultContentTypeText BetaManagedAgentsSearchResultContentType = "text"` - `Source string` The URL source of the search result. - `Title string` The title of the search result. - `Type BetaManagedAgentsSearchResultBlockType` - `const BetaManagedAgentsSearchResultBlockTypeSearchResult BetaManagedAgentsSearchResultBlockType = "search_result"` - `IsError bool` Whether the tool execution resulted in an error. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Routes this result to a subagent thread. Copy from the `agent.custom_tool_use` event's `session_thread_id`. - `type BetaManagedAgentsUserDefineOutcomeEvent struct{…}` Echo of a `user.define_outcome` input event. Carries the server-generated `outcome_id` that subsequent `span.outcome_evaluation_*` events reference. - `ID string` Unique identifier for this event. - `Description string` What the agent should produce. Copied from the input event. - `MaxIterations int64` Evaluate-then-revise cycles before giving up. Default 3, max 20. - `OutcomeID string` Server-generated `outc_` ID for this outcome. Referenced by `span.outcome_evaluation_*` events and the session's `outcome_evaluations` list. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Rubric BetaManagedAgentsUserDefineOutcomeEventRubricUnion` Rubric for grading the quality of an outcome. - `type BetaManagedAgentsFileRubric struct{…}` Rubric referenced by a file uploaded via the Files API. - `FileID string` ID of the rubric file. - `Type BetaManagedAgentsFileRubricType` - `const BetaManagedAgentsFileRubricTypeFile BetaManagedAgentsFileRubricType = "file"` - `type BetaManagedAgentsTextRubric struct{…}` Rubric content provided inline as text. - `Content string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `Type BetaManagedAgentsTextRubricType` - `const BetaManagedAgentsTextRubricTypeText BetaManagedAgentsTextRubricType = "text"` - `Type BetaManagedAgentsUserDefineOutcomeEventType` - `const BetaManagedAgentsUserDefineOutcomeEventTypeUserDefineOutcome BetaManagedAgentsUserDefineOutcomeEventType = "user.define_outcome"` - `type BetaManagedAgentsUserToolResultEvent struct{…}` Event sent by the client providing the result of an agent-toolset tool execution. Only valid on `self_hosted` environments, where sandbox-routed tools are executed by the client rather than the server. - `ID string` Unique identifier for this event. - `ToolUseID string` The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserToolResultEventType` - `const BetaManagedAgentsUserToolResultEventTypeUserToolResult BetaManagedAgentsUserToolResultEventType = "user.tool_result"` - `Content []BetaManagedAgentsUserToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `IsError bool` Whether the tool execution resulted in an error. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Routes this result to a subagent thread. Copy from the `agent.tool_use` event's `session_thread_id`. ### Beta Managed Agents Session Deleted Event - `type BetaManagedAgentsSessionDeletedEvent struct{…}` Emitted when a session has been deleted. Terminates any active event stream — no further events will be emitted for this session. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionDeletedEventType` - `const BetaManagedAgentsSessionDeletedEventTypeSessionDeleted BetaManagedAgentsSessionDeletedEventType = "session.deleted"` ### Beta Managed Agents Session End Turn - `type BetaManagedAgentsSessionEndTurn struct{…}` The agent completed its turn naturally and is ready for the next user message. - `Type BetaManagedAgentsSessionEndTurnType` - `const BetaManagedAgentsSessionEndTurnTypeEndTurn BetaManagedAgentsSessionEndTurnType = "end_turn"` ### Beta Managed Agents Session Error Event - `type BetaManagedAgentsSessionErrorEvent struct{…}` An error event indicating a problem occurred during session execution. - `ID string` Unique identifier for this event. - `Error BetaManagedAgentsSessionErrorEventErrorUnion` An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on `retry_status` and `message` alone. - `type BetaManagedAgentsUnknownError struct{…}` An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on `retry_status` and `message` alone. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsUnknownErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `Type BetaManagedAgentsRetryStatusRetryingType` - `const BetaManagedAgentsRetryStatusRetryingTypeRetrying BetaManagedAgentsRetryStatusRetryingType = "retrying"` - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `Type BetaManagedAgentsRetryStatusExhaustedType` - `const BetaManagedAgentsRetryStatusExhaustedTypeExhausted BetaManagedAgentsRetryStatusExhaustedType = "exhausted"` - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsRetryStatusTerminalType` - `const BetaManagedAgentsRetryStatusTerminalTypeTerminal BetaManagedAgentsRetryStatusTerminalType = "terminal"` - `Type BetaManagedAgentsUnknownErrorType` - `const BetaManagedAgentsUnknownErrorTypeUnknownError BetaManagedAgentsUnknownErrorType = "unknown_error"` - `type BetaManagedAgentsModelOverloadedError struct{…}` The model is currently overloaded. Emitted after automatic retries are exhausted. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsModelOverloadedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsModelOverloadedErrorType` - `const BetaManagedAgentsModelOverloadedErrorTypeModelOverloadedError BetaManagedAgentsModelOverloadedErrorType = "model_overloaded_error"` - `type BetaManagedAgentsModelRateLimitedError struct{…}` The model request was rate-limited. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsModelRateLimitedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsModelRateLimitedErrorType` - `const BetaManagedAgentsModelRateLimitedErrorTypeModelRateLimitedError BetaManagedAgentsModelRateLimitedErrorType = "model_rate_limited_error"` - `type BetaManagedAgentsModelRequestFailedError struct{…}` A model request failed for a reason other than overload or rate-limiting. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsModelRequestFailedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsModelRequestFailedErrorType` - `const BetaManagedAgentsModelRequestFailedErrorTypeModelRequestFailedError BetaManagedAgentsModelRequestFailedErrorType = "model_request_failed_error"` - `type BetaManagedAgentsMCPConnectionFailedError struct{…}` Failed to connect to an MCP server. - `MCPServerName string` Name of the MCP server that failed to connect. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsMCPConnectionFailedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsMCPConnectionFailedErrorType` - `const BetaManagedAgentsMCPConnectionFailedErrorTypeMCPConnectionFailedError BetaManagedAgentsMCPConnectionFailedErrorType = "mcp_connection_failed_error"` - `type BetaManagedAgentsMCPAuthenticationFailedError struct{…}` Authentication to an MCP server failed. - `MCPServerName string` Name of the MCP server that failed authentication. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsMCPAuthenticationFailedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsMCPAuthenticationFailedErrorType` - `const BetaManagedAgentsMCPAuthenticationFailedErrorTypeMCPAuthenticationFailedError BetaManagedAgentsMCPAuthenticationFailedErrorType = "mcp_authentication_failed_error"` - `type BetaManagedAgentsBillingError struct{…}` The caller's organization or workspace cannot make model requests — out of credits or spend limit reached. Retrying with the same credentials will not succeed; the caller must resolve the billing state. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsBillingErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsBillingErrorType` - `const BetaManagedAgentsBillingErrorTypeBillingError BetaManagedAgentsBillingErrorType = "billing_error"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionErrorEventType` - `const BetaManagedAgentsSessionErrorEventTypeSessionError BetaManagedAgentsSessionErrorEventType = "session.error"` ### Beta Managed Agents Session Event - `type BetaManagedAgentsSessionEventUnion interface{…}` Union type for all event types in a session. - `type BetaManagedAgentsUserMessageEvent struct{…}` A user message event in the session conversation. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsUserMessageEventContentUnion` Array of content blocks comprising the user message. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `const BetaManagedAgentsTextBlockTypeText BetaManagedAgentsTextBlockType = "text"` - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `Source BetaManagedAgentsImageBlockSourceUnion` Union type for image source variants. - `type BetaManagedAgentsBase64ImageSource struct{…}` Base64-encoded image data. - `Data string` Base64-encoded image data. - `MediaType string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `Type BetaManagedAgentsBase64ImageSourceType` - `const BetaManagedAgentsBase64ImageSourceTypeBase64 BetaManagedAgentsBase64ImageSourceType = "base64"` - `type BetaManagedAgentsURLImageSource struct{…}` Image referenced by URL. - `Type BetaManagedAgentsURLImageSourceType` - `const BetaManagedAgentsURLImageSourceTypeURL BetaManagedAgentsURLImageSourceType = "url"` - `URL string` URL of the image to fetch. - `type BetaManagedAgentsFileImageSource struct{…}` Image referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileImageSourceType` - `const BetaManagedAgentsFileImageSourceTypeFile BetaManagedAgentsFileImageSourceType = "file"` - `Type BetaManagedAgentsImageBlockType` - `const BetaManagedAgentsImageBlockTypeImage BetaManagedAgentsImageBlockType = "image"` - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `Source BetaManagedAgentsDocumentBlockSourceUnion` Union type for document source variants. - `type BetaManagedAgentsBase64DocumentSource struct{…}` Base64-encoded document data. - `Data string` Base64-encoded document data. - `MediaType string` MIME type of the document (e.g., "application/pdf"). - `Type BetaManagedAgentsBase64DocumentSourceType` - `const BetaManagedAgentsBase64DocumentSourceTypeBase64 BetaManagedAgentsBase64DocumentSourceType = "base64"` - `type BetaManagedAgentsPlainTextDocumentSource struct{…}` Plain text document content. - `Data string` The plain text content. - `MediaType BetaManagedAgentsPlainTextDocumentSourceMediaType` MIME type of the text content. Must be "text/plain". - `const BetaManagedAgentsPlainTextDocumentSourceMediaTypeTextPlain BetaManagedAgentsPlainTextDocumentSourceMediaType = "text/plain"` - `Type BetaManagedAgentsPlainTextDocumentSourceType` - `const BetaManagedAgentsPlainTextDocumentSourceTypeText BetaManagedAgentsPlainTextDocumentSourceType = "text"` - `type BetaManagedAgentsURLDocumentSource struct{…}` Document referenced by URL. - `Type BetaManagedAgentsURLDocumentSourceType` - `const BetaManagedAgentsURLDocumentSourceTypeURL BetaManagedAgentsURLDocumentSourceType = "url"` - `URL string` URL of the document to fetch. - `type BetaManagedAgentsFileDocumentSource struct{…}` Document referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileDocumentSourceType` - `const BetaManagedAgentsFileDocumentSourceTypeFile BetaManagedAgentsFileDocumentSourceType = "file"` - `Type BetaManagedAgentsDocumentBlockType` - `const BetaManagedAgentsDocumentBlockTypeDocument BetaManagedAgentsDocumentBlockType = "document"` - `Context string` Additional context about the document for the model. - `Title string` The title of the document. - `Type BetaManagedAgentsUserMessageEventType` - `const BetaManagedAgentsUserMessageEventTypeUserMessage BetaManagedAgentsUserMessageEventType = "user.message"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `type BetaManagedAgentsUserInterruptEvent struct{…}` An interrupt event that pauses agent execution and returns control to the user. - `ID string` Unique identifier for this event. - `Type BetaManagedAgentsUserInterruptEventType` - `const BetaManagedAgentsUserInterruptEventTypeUserInterrupt BetaManagedAgentsUserInterruptEventType = "user.interrupt"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. - `type BetaManagedAgentsUserToolConfirmationEvent struct{…}` A tool confirmation event that approves or denies a pending tool execution. - `ID string` Unique identifier for this event. - `Result BetaManagedAgentsUserToolConfirmationEventResult` UserToolConfirmationResult enum - `const BetaManagedAgentsUserToolConfirmationEventResultAllow BetaManagedAgentsUserToolConfirmationEventResult = "allow"` - `const BetaManagedAgentsUserToolConfirmationEventResultDeny BetaManagedAgentsUserToolConfirmationEventResult = "deny"` - `ToolUseID string` The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserToolConfirmationEventType` - `const BetaManagedAgentsUserToolConfirmationEventTypeUserToolConfirmation BetaManagedAgentsUserToolConfirmationEventType = "user.tool_confirmation"` - `DenyMessage string` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` When set, the confirmation routes to this subagent's thread rather than the primary. Echo this from the `session_thread_id` on the `agent.tool_use` or `agent.mcp_tool_use` event that prompted the approval. - `type BetaManagedAgentsUserCustomToolResultEvent struct{…}` Event sent by the client providing the result of a custom tool execution. - `ID string` Unique identifier for this event. - `CustomToolUseID string` The id of the `agent.custom_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserCustomToolResultEventType` - `const BetaManagedAgentsUserCustomToolResultEventTypeUserCustomToolResult BetaManagedAgentsUserCustomToolResultEventType = "user.custom_tool_result"` - `Content []BetaManagedAgentsUserCustomToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `Citations BetaManagedAgentsSearchResultCitations` Citation settings for a search result. - `Enabled bool` Whether citations are enabled for this search result. - `Content []BetaManagedAgentsSearchResultContent` Array of text content blocks from the search result. - `Text string` The text content. - `Type BetaManagedAgentsSearchResultContentType` - `const BetaManagedAgentsSearchResultContentTypeText BetaManagedAgentsSearchResultContentType = "text"` - `Source string` The URL source of the search result. - `Title string` The title of the search result. - `Type BetaManagedAgentsSearchResultBlockType` - `const BetaManagedAgentsSearchResultBlockTypeSearchResult BetaManagedAgentsSearchResultBlockType = "search_result"` - `IsError bool` Whether the tool execution resulted in an error. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Routes this result to a subagent thread. Copy from the `agent.custom_tool_use` event's `session_thread_id`. - `type BetaManagedAgentsAgentCustomToolUseEvent struct{…}` Event emitted when the agent calls a custom tool. The session goes idle until the client sends a `user.custom_tool_result` event with the result. - `ID string` Unique identifier for this event. - `Input map[string, any]` Input parameters for the tool call. - `Name string` Name of the custom tool being called. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentCustomToolUseEventType` - `const BetaManagedAgentsAgentCustomToolUseEventTypeAgentCustomToolUse BetaManagedAgentsAgentCustomToolUseEventType = "agent.custom_tool_use"` - `SessionThreadID string` When set, this event was cross-posted from a subagent's thread to surface its custom tool use on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.custom_tool_result` event to route the result back. - `type BetaManagedAgentsAgentMessageEvent struct{…}` An agent response event in the session conversation. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsTextBlock` Array of text blocks comprising the agent response. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentMessageEventType` - `const BetaManagedAgentsAgentMessageEventTypeAgentMessage BetaManagedAgentsAgentMessageEventType = "agent.message"` - `type BetaManagedAgentsAgentThinkingEvent struct{…}` Indicates the agent is making forward progress via extended thinking. A progress signal, not a content carrier. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentThinkingEventType` - `const BetaManagedAgentsAgentThinkingEventTypeAgentThinking BetaManagedAgentsAgentThinkingEventType = "agent.thinking"` - `type BetaManagedAgentsAgentMCPToolUseEvent struct{…}` Event emitted when the agent invokes a tool provided by an MCP server. - `ID string` Unique identifier for this event. - `Input map[string, any]` Input parameters for the tool call. - `MCPServerName string` Name of the MCP server providing the tool. - `Name string` Name of the MCP tool being used. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentMCPToolUseEventType` - `const BetaManagedAgentsAgentMCPToolUseEventTypeAgentMCPToolUse BetaManagedAgentsAgentMCPToolUseEventType = "agent.mcp_tool_use"` - `EvaluatedPermission BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission` AgentEvaluatedPermission enum - `const BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermissionAllow BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission = "allow"` - `const BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermissionAsk BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission = "ask"` - `const BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermissionDeny BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission = "deny"` - `SessionThreadID string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `type BetaManagedAgentsAgentMCPToolResultEvent struct{…}` Event representing the result of an MCP tool execution. - `ID string` Unique identifier for this event. - `MCPToolUseID string` The id of the `agent.mcp_tool_use` event this result corresponds to. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentMCPToolResultEventType` - `const BetaManagedAgentsAgentMCPToolResultEventTypeAgentMCPToolResult BetaManagedAgentsAgentMCPToolResultEventType = "agent.mcp_tool_result"` - `Content []BetaManagedAgentsAgentMCPToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `IsError bool` Whether the tool execution resulted in an error. - `type BetaManagedAgentsAgentToolUseEvent struct{…}` Event emitted when the agent invokes a built-in agent tool. - `ID string` Unique identifier for this event. - `Input map[string, any]` Input parameters for the tool call. - `Name string` Name of the agent tool being used. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentToolUseEventType` - `const BetaManagedAgentsAgentToolUseEventTypeAgentToolUse BetaManagedAgentsAgentToolUseEventType = "agent.tool_use"` - `EvaluatedPermission BetaManagedAgentsAgentToolUseEventEvaluatedPermission` AgentEvaluatedPermission enum - `const BetaManagedAgentsAgentToolUseEventEvaluatedPermissionAllow BetaManagedAgentsAgentToolUseEventEvaluatedPermission = "allow"` - `const BetaManagedAgentsAgentToolUseEventEvaluatedPermissionAsk BetaManagedAgentsAgentToolUseEventEvaluatedPermission = "ask"` - `const BetaManagedAgentsAgentToolUseEventEvaluatedPermissionDeny BetaManagedAgentsAgentToolUseEventEvaluatedPermission = "deny"` - `SessionThreadID string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `type BetaManagedAgentsAgentToolResultEvent struct{…}` Event representing the result of an agent tool execution. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `ToolUseID string` The id of the `agent.tool_use` event this result corresponds to. - `Type BetaManagedAgentsAgentToolResultEventType` - `const BetaManagedAgentsAgentToolResultEventTypeAgentToolResult BetaManagedAgentsAgentToolResultEventType = "agent.tool_result"` - `Content []BetaManagedAgentsAgentToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `IsError bool` Whether the tool execution resulted in an error. - `type BetaManagedAgentsAgentThreadMessageReceivedEvent struct{…}` Delivery event written to the target thread's input stream when an agent-to-agent message arrives. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsAgentThreadMessageReceivedEventContentUnion` Message content blocks. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `FromSessionThreadID string` Public `sthr_` ID of the thread that sent the message. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentThreadMessageReceivedEventType` - `const BetaManagedAgentsAgentThreadMessageReceivedEventTypeAgentThreadMessageReceived BetaManagedAgentsAgentThreadMessageReceivedEventType = "agent.thread_message_received"` - `FromAgentName string` Name of the callable agent this message came from. Absent when received from the primary agent. - `type BetaManagedAgentsAgentThreadMessageSentEvent struct{…}` Observability event emitted to the sender's output stream when an agent-to-agent message is sent. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsAgentThreadMessageSentEventContentUnion` Message content blocks. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `ProcessedAt Time` A timestamp in RFC 3339 format - `ToSessionThreadID string` Public `sthr_` ID of the thread the message was sent to. - `Type BetaManagedAgentsAgentThreadMessageSentEventType` - `const BetaManagedAgentsAgentThreadMessageSentEventTypeAgentThreadMessageSent BetaManagedAgentsAgentThreadMessageSentEventType = "agent.thread_message_sent"` - `ToAgentName string` Name of the callable agent this message was sent to. Absent when sent to the primary agent. - `type BetaManagedAgentsAgentThreadContextCompactedEvent struct{…}` Indicates that context compaction (summarization) occurred during the session. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentThreadContextCompactedEventType` - `const BetaManagedAgentsAgentThreadContextCompactedEventTypeAgentThreadContextCompacted BetaManagedAgentsAgentThreadContextCompactedEventType = "agent.thread_context_compacted"` - `type BetaManagedAgentsSessionErrorEvent struct{…}` An error event indicating a problem occurred during session execution. - `ID string` Unique identifier for this event. - `Error BetaManagedAgentsSessionErrorEventErrorUnion` An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on `retry_status` and `message` alone. - `type BetaManagedAgentsUnknownError struct{…}` An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on `retry_status` and `message` alone. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsUnknownErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `Type BetaManagedAgentsRetryStatusRetryingType` - `const BetaManagedAgentsRetryStatusRetryingTypeRetrying BetaManagedAgentsRetryStatusRetryingType = "retrying"` - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `Type BetaManagedAgentsRetryStatusExhaustedType` - `const BetaManagedAgentsRetryStatusExhaustedTypeExhausted BetaManagedAgentsRetryStatusExhaustedType = "exhausted"` - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsRetryStatusTerminalType` - `const BetaManagedAgentsRetryStatusTerminalTypeTerminal BetaManagedAgentsRetryStatusTerminalType = "terminal"` - `Type BetaManagedAgentsUnknownErrorType` - `const BetaManagedAgentsUnknownErrorTypeUnknownError BetaManagedAgentsUnknownErrorType = "unknown_error"` - `type BetaManagedAgentsModelOverloadedError struct{…}` The model is currently overloaded. Emitted after automatic retries are exhausted. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsModelOverloadedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsModelOverloadedErrorType` - `const BetaManagedAgentsModelOverloadedErrorTypeModelOverloadedError BetaManagedAgentsModelOverloadedErrorType = "model_overloaded_error"` - `type BetaManagedAgentsModelRateLimitedError struct{…}` The model request was rate-limited. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsModelRateLimitedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsModelRateLimitedErrorType` - `const BetaManagedAgentsModelRateLimitedErrorTypeModelRateLimitedError BetaManagedAgentsModelRateLimitedErrorType = "model_rate_limited_error"` - `type BetaManagedAgentsModelRequestFailedError struct{…}` A model request failed for a reason other than overload or rate-limiting. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsModelRequestFailedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsModelRequestFailedErrorType` - `const BetaManagedAgentsModelRequestFailedErrorTypeModelRequestFailedError BetaManagedAgentsModelRequestFailedErrorType = "model_request_failed_error"` - `type BetaManagedAgentsMCPConnectionFailedError struct{…}` Failed to connect to an MCP server. - `MCPServerName string` Name of the MCP server that failed to connect. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsMCPConnectionFailedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsMCPConnectionFailedErrorType` - `const BetaManagedAgentsMCPConnectionFailedErrorTypeMCPConnectionFailedError BetaManagedAgentsMCPConnectionFailedErrorType = "mcp_connection_failed_error"` - `type BetaManagedAgentsMCPAuthenticationFailedError struct{…}` Authentication to an MCP server failed. - `MCPServerName string` Name of the MCP server that failed authentication. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsMCPAuthenticationFailedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsMCPAuthenticationFailedErrorType` - `const BetaManagedAgentsMCPAuthenticationFailedErrorTypeMCPAuthenticationFailedError BetaManagedAgentsMCPAuthenticationFailedErrorType = "mcp_authentication_failed_error"` - `type BetaManagedAgentsBillingError struct{…}` The caller's organization or workspace cannot make model requests — out of credits or spend limit reached. Retrying with the same credentials will not succeed; the caller must resolve the billing state. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsBillingErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsBillingErrorType` - `const BetaManagedAgentsBillingErrorTypeBillingError BetaManagedAgentsBillingErrorType = "billing_error"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionErrorEventType` - `const BetaManagedAgentsSessionErrorEventTypeSessionError BetaManagedAgentsSessionErrorEventType = "session.error"` - `type BetaManagedAgentsSessionStatusRescheduledEvent struct{…}` Indicates the session is recovering from an error state and is rescheduled for execution. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionStatusRescheduledEventType` - `const BetaManagedAgentsSessionStatusRescheduledEventTypeSessionStatusRescheduled BetaManagedAgentsSessionStatusRescheduledEventType = "session.status_rescheduled"` - `type BetaManagedAgentsSessionStatusRunningEvent struct{…}` Indicates the session is actively running and the agent is working. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionStatusRunningEventType` - `const BetaManagedAgentsSessionStatusRunningEventTypeSessionStatusRunning BetaManagedAgentsSessionStatusRunningEventType = "session.status_running"` - `type BetaManagedAgentsSessionStatusIdleEvent struct{…}` Indicates the agent has paused and is awaiting user input. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `StopReason BetaManagedAgentsSessionStatusIdleEventStopReasonUnion` The agent completed its turn naturally and is ready for the next user message. - `type BetaManagedAgentsSessionEndTurn struct{…}` The agent completed its turn naturally and is ready for the next user message. - `Type BetaManagedAgentsSessionEndTurnType` - `const BetaManagedAgentsSessionEndTurnTypeEndTurn BetaManagedAgentsSessionEndTurnType = "end_turn"` - `type BetaManagedAgentsSessionRequiresAction struct{…}` The agent is idle waiting on one or more blocking user-input events (tool confirmation, custom tool result, etc.). Resolving all of them transitions the session back to running. - `EventIDs []string` The ids of events the agent is blocked on. Resolving fewer than all re-emits `session.status_idle` with the remainder. - `Type BetaManagedAgentsSessionRequiresActionType` - `const BetaManagedAgentsSessionRequiresActionTypeRequiresAction BetaManagedAgentsSessionRequiresActionType = "requires_action"` - `type BetaManagedAgentsSessionRetriesExhausted struct{…}` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `Type BetaManagedAgentsSessionRetriesExhaustedType` - `const BetaManagedAgentsSessionRetriesExhaustedTypeRetriesExhausted BetaManagedAgentsSessionRetriesExhaustedType = "retries_exhausted"` - `Type BetaManagedAgentsSessionStatusIdleEventType` - `const BetaManagedAgentsSessionStatusIdleEventTypeSessionStatusIdle BetaManagedAgentsSessionStatusIdleEventType = "session.status_idle"` - `type BetaManagedAgentsSessionStatusTerminatedEvent struct{…}` Indicates the session has terminated, either due to an error or completion. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionStatusTerminatedEventType` - `const BetaManagedAgentsSessionStatusTerminatedEventTypeSessionStatusTerminated BetaManagedAgentsSessionStatusTerminatedEventType = "session.status_terminated"` - `type BetaManagedAgentsSessionThreadCreatedEvent struct{…}` Emitted when a subagent is spawned as a new thread. Written to the parent thread's output stream so clients observing the session see child creation. - `ID string` Unique identifier for this event. - `AgentName string` Name of the callable agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public `sthr_` ID of the newly created thread. - `Type BetaManagedAgentsSessionThreadCreatedEventType` - `const BetaManagedAgentsSessionThreadCreatedEventTypeSessionThreadCreated BetaManagedAgentsSessionThreadCreatedEventType = "session.thread_created"` - `type BetaManagedAgentsSpanOutcomeEvaluationStartEvent struct{…}` Emitted when an outcome evaluation cycle begins. - `ID string` Unique identifier for this event. - `Iteration int64` 0-indexed revision cycle. 0 is the first evaluation; 1 is the re-evaluation after the first revision; etc. - `OutcomeID string` The `outc_` ID of the outcome being evaluated. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanOutcomeEvaluationStartEventType` - `const BetaManagedAgentsSpanOutcomeEvaluationStartEventTypeSpanOutcomeEvaluationStart BetaManagedAgentsSpanOutcomeEvaluationStartEventType = "span.outcome_evaluation_start"` - `type BetaManagedAgentsSpanOutcomeEvaluationEndEvent struct{…}` Emitted when an outcome evaluation cycle completes. Carries the verdict and aggregate token usage. A verdict of `needs_revision` means another evaluation cycle follows; `satisfied`, `max_iterations_reached`, `failed`, or `interrupted` are terminal — no further evaluation cycles follow. - `ID string` Unique identifier for this event. - `Explanation string` Human-readable explanation of the verdict. For `needs_revision`, describes which criteria failed and why. - `Iteration int64` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `OutcomeEvaluationStartID string` The id of the corresponding `span.outcome_evaluation_start` event. - `OutcomeID string` The `outc_` ID of the outcome being evaluated. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Result string` Evaluation verdict. 'satisfied': criteria met, session goes idle. 'needs_revision': criteria not met, another revision cycle follows. 'max_iterations_reached': evaluation budget exhausted with criteria still unmet — one final acknowledgment turn follows before the session goes idle, but no further evaluation runs. 'failed': grader determined the rubric does not apply to the deliverables. 'interrupted': user sent an interrupt while evaluation was in progress. - `Type BetaManagedAgentsSpanOutcomeEvaluationEndEventType` - `const BetaManagedAgentsSpanOutcomeEvaluationEndEventTypeSpanOutcomeEvaluationEnd BetaManagedAgentsSpanOutcomeEvaluationEndEventType = "span.outcome_evaluation_end"` - `Usage BetaManagedAgentsSpanModelUsage` Token usage for a single model request. - `CacheCreationInputTokens int64` Tokens used to create prompt cache in this request. - `CacheReadInputTokens int64` Tokens read from prompt cache in this request. - `InputTokens int64` Input tokens consumed by this request. - `OutputTokens int64` Output tokens generated by this request. - `Speed BetaManagedAgentsSpanModelUsageSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsSpanModelUsageSpeedStandard BetaManagedAgentsSpanModelUsageSpeed = "standard"` - `const BetaManagedAgentsSpanModelUsageSpeedFast BetaManagedAgentsSpanModelUsageSpeed = "fast"` - `type BetaManagedAgentsSpanModelRequestStartEvent struct{…}` Emitted when a model request is initiated by the agent. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanModelRequestStartEventType` - `const BetaManagedAgentsSpanModelRequestStartEventTypeSpanModelRequestStart BetaManagedAgentsSpanModelRequestStartEventType = "span.model_request_start"` - `type BetaManagedAgentsSpanModelRequestEndEvent struct{…}` Emitted when a model request completes. - `ID string` Unique identifier for this event. - `IsError bool` Whether the model request resulted in an error. - `ModelRequestStartID string` The id of the corresponding `span.model_request_start` event. - `ModelUsage BetaManagedAgentsSpanModelUsage` Token usage for a single model request. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanModelRequestEndEventType` - `const BetaManagedAgentsSpanModelRequestEndEventTypeSpanModelRequestEnd BetaManagedAgentsSpanModelRequestEndEventType = "span.model_request_end"` - `type BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent struct{…}` Periodic heartbeat emitted while an outcome evaluation cycle is in progress. Distinguishes 'evaluation is actively running' from 'evaluation is stuck' between the corresponding `span.outcome_evaluation_start` and `span.outcome_evaluation_end` events. - `ID string` Unique identifier for this event. - `Iteration int64` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `OutcomeID string` The `outc_` ID of the outcome being evaluated. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanOutcomeEvaluationOngoingEventType` - `const BetaManagedAgentsSpanOutcomeEvaluationOngoingEventTypeSpanOutcomeEvaluationOngoing BetaManagedAgentsSpanOutcomeEvaluationOngoingEventType = "span.outcome_evaluation_ongoing"` - `type BetaManagedAgentsUserDefineOutcomeEvent struct{…}` Echo of a `user.define_outcome` input event. Carries the server-generated `outcome_id` that subsequent `span.outcome_evaluation_*` events reference. - `ID string` Unique identifier for this event. - `Description string` What the agent should produce. Copied from the input event. - `MaxIterations int64` Evaluate-then-revise cycles before giving up. Default 3, max 20. - `OutcomeID string` Server-generated `outc_` ID for this outcome. Referenced by `span.outcome_evaluation_*` events and the session's `outcome_evaluations` list. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Rubric BetaManagedAgentsUserDefineOutcomeEventRubricUnion` Rubric for grading the quality of an outcome. - `type BetaManagedAgentsFileRubric struct{…}` Rubric referenced by a file uploaded via the Files API. - `FileID string` ID of the rubric file. - `Type BetaManagedAgentsFileRubricType` - `const BetaManagedAgentsFileRubricTypeFile BetaManagedAgentsFileRubricType = "file"` - `type BetaManagedAgentsTextRubric struct{…}` Rubric content provided inline as text. - `Content string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `Type BetaManagedAgentsTextRubricType` - `const BetaManagedAgentsTextRubricTypeText BetaManagedAgentsTextRubricType = "text"` - `Type BetaManagedAgentsUserDefineOutcomeEventType` - `const BetaManagedAgentsUserDefineOutcomeEventTypeUserDefineOutcome BetaManagedAgentsUserDefineOutcomeEventType = "user.define_outcome"` - `type BetaManagedAgentsSessionDeletedEvent struct{…}` Emitted when a session has been deleted. Terminates any active event stream — no further events will be emitted for this session. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionDeletedEventType` - `const BetaManagedAgentsSessionDeletedEventTypeSessionDeleted BetaManagedAgentsSessionDeletedEventType = "session.deleted"` - `type BetaManagedAgentsSessionThreadStatusRunningEvent struct{…}` A session thread has begun executing. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that started running. - `Type BetaManagedAgentsSessionThreadStatusRunningEventType` - `const BetaManagedAgentsSessionThreadStatusRunningEventTypeSessionThreadStatusRunning BetaManagedAgentsSessionThreadStatusRunningEventType = "session.thread_status_running"` - `type BetaManagedAgentsSessionThreadStatusIdleEvent struct{…}` A session thread has yielded and is awaiting input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that went idle. - `StopReason BetaManagedAgentsSessionThreadStatusIdleEventStopReasonUnion` The agent completed its turn naturally and is ready for the next user message. - `type BetaManagedAgentsSessionEndTurn struct{…}` The agent completed its turn naturally and is ready for the next user message. - `type BetaManagedAgentsSessionRequiresAction struct{…}` The agent is idle waiting on one or more blocking user-input events (tool confirmation, custom tool result, etc.). Resolving all of them transitions the session back to running. - `type BetaManagedAgentsSessionRetriesExhausted struct{…}` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `Type BetaManagedAgentsSessionThreadStatusIdleEventType` - `const BetaManagedAgentsSessionThreadStatusIdleEventTypeSessionThreadStatusIdle BetaManagedAgentsSessionThreadStatusIdleEventType = "session.thread_status_idle"` - `type BetaManagedAgentsSessionThreadStatusTerminatedEvent struct{…}` A session thread has terminated and will accept no further input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that terminated. - `Type BetaManagedAgentsSessionThreadStatusTerminatedEventType` - `const BetaManagedAgentsSessionThreadStatusTerminatedEventTypeSessionThreadStatusTerminated BetaManagedAgentsSessionThreadStatusTerminatedEventType = "session.thread_status_terminated"` - `type BetaManagedAgentsUserToolResultEvent struct{…}` Event sent by the client providing the result of an agent-toolset tool execution. Only valid on `self_hosted` environments, where sandbox-routed tools are executed by the client rather than the server. - `ID string` Unique identifier for this event. - `ToolUseID string` The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserToolResultEventType` - `const BetaManagedAgentsUserToolResultEventTypeUserToolResult BetaManagedAgentsUserToolResultEventType = "user.tool_result"` - `Content []BetaManagedAgentsUserToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `IsError bool` Whether the tool execution resulted in an error. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Routes this result to a subagent thread. Copy from the `agent.tool_use` event's `session_thread_id`. - `type BetaManagedAgentsSessionThreadStatusRescheduledEvent struct{…}` A session thread hit a transient error and is retrying automatically. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that is retrying. - `Type BetaManagedAgentsSessionThreadStatusRescheduledEventType` - `const BetaManagedAgentsSessionThreadStatusRescheduledEventTypeSessionThreadStatusRescheduled BetaManagedAgentsSessionThreadStatusRescheduledEventType = "session.thread_status_rescheduled"` - `type BetaManagedAgentsSessionUpdatedEvent struct{…}` Emitted when an UpdateSession request changed at least one field. Carries only the fields that changed; absent fields were not part of the update. The new configuration applies from the next turn. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionUpdatedEventType` - `const BetaManagedAgentsSessionUpdatedEventTypeSessionUpdated BetaManagedAgentsSessionUpdatedEventType = "session.updated"` - `Agent BetaManagedAgentsSessionAgent` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Multiagent BetaManagedAgentsSessionMultiagentCoordinator` Resolved coordinator topology with full agent definitions for each roster member. - `Agents []BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `Name string` - `Skills []BetaManagedAgentsSessionThreadAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsSessionThreadAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsSessionThreadAgentType` - `const BetaManagedAgentsSessionThreadAgentTypeAgent BetaManagedAgentsSessionThreadAgentType = "agent"` - `Version int64` - `Type BetaManagedAgentsSessionMultiagentCoordinatorType` - `const BetaManagedAgentsSessionMultiagentCoordinatorTypeCoordinator BetaManagedAgentsSessionMultiagentCoordinatorType = "coordinator"` - `Name string` - `Skills []BetaManagedAgentsSessionAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `System string` - `Tools []BetaManagedAgentsSessionAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `type BetaManagedAgentsMCPToolset struct{…}` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Type BetaManagedAgentsSessionAgentType` - `const BetaManagedAgentsSessionAgentTypeAgent BetaManagedAgentsSessionAgentType = "agent"` - `Version int64` - `Metadata map[string, string]` The session's full metadata bag after the update. Present when the update set non-empty metadata; absent when metadata was unchanged or cleared to empty. - `Title string` The session's new title. Present only when the update changed it. ### Beta Managed Agents Session Requires Action - `type BetaManagedAgentsSessionRequiresAction struct{…}` The agent is idle waiting on one or more blocking user-input events (tool confirmation, custom tool result, etc.). Resolving all of them transitions the session back to running. - `EventIDs []string` The ids of events the agent is blocked on. Resolving fewer than all re-emits `session.status_idle` with the remainder. - `Type BetaManagedAgentsSessionRequiresActionType` - `const BetaManagedAgentsSessionRequiresActionTypeRequiresAction BetaManagedAgentsSessionRequiresActionType = "requires_action"` ### Beta Managed Agents Session Retries Exhausted - `type BetaManagedAgentsSessionRetriesExhausted struct{…}` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `Type BetaManagedAgentsSessionRetriesExhaustedType` - `const BetaManagedAgentsSessionRetriesExhaustedTypeRetriesExhausted BetaManagedAgentsSessionRetriesExhaustedType = "retries_exhausted"` ### Beta Managed Agents Session Status Idle Event - `type BetaManagedAgentsSessionStatusIdleEvent struct{…}` Indicates the agent has paused and is awaiting user input. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `StopReason BetaManagedAgentsSessionStatusIdleEventStopReasonUnion` The agent completed its turn naturally and is ready for the next user message. - `type BetaManagedAgentsSessionEndTurn struct{…}` The agent completed its turn naturally and is ready for the next user message. - `Type BetaManagedAgentsSessionEndTurnType` - `const BetaManagedAgentsSessionEndTurnTypeEndTurn BetaManagedAgentsSessionEndTurnType = "end_turn"` - `type BetaManagedAgentsSessionRequiresAction struct{…}` The agent is idle waiting on one or more blocking user-input events (tool confirmation, custom tool result, etc.). Resolving all of them transitions the session back to running. - `EventIDs []string` The ids of events the agent is blocked on. Resolving fewer than all re-emits `session.status_idle` with the remainder. - `Type BetaManagedAgentsSessionRequiresActionType` - `const BetaManagedAgentsSessionRequiresActionTypeRequiresAction BetaManagedAgentsSessionRequiresActionType = "requires_action"` - `type BetaManagedAgentsSessionRetriesExhausted struct{…}` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `Type BetaManagedAgentsSessionRetriesExhaustedType` - `const BetaManagedAgentsSessionRetriesExhaustedTypeRetriesExhausted BetaManagedAgentsSessionRetriesExhaustedType = "retries_exhausted"` - `Type BetaManagedAgentsSessionStatusIdleEventType` - `const BetaManagedAgentsSessionStatusIdleEventTypeSessionStatusIdle BetaManagedAgentsSessionStatusIdleEventType = "session.status_idle"` ### Beta Managed Agents Session Status Rescheduled Event - `type BetaManagedAgentsSessionStatusRescheduledEvent struct{…}` Indicates the session is recovering from an error state and is rescheduled for execution. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionStatusRescheduledEventType` - `const BetaManagedAgentsSessionStatusRescheduledEventTypeSessionStatusRescheduled BetaManagedAgentsSessionStatusRescheduledEventType = "session.status_rescheduled"` ### Beta Managed Agents Session Status Running Event - `type BetaManagedAgentsSessionStatusRunningEvent struct{…}` Indicates the session is actively running and the agent is working. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionStatusRunningEventType` - `const BetaManagedAgentsSessionStatusRunningEventTypeSessionStatusRunning BetaManagedAgentsSessionStatusRunningEventType = "session.status_running"` ### Beta Managed Agents Session Status Terminated Event - `type BetaManagedAgentsSessionStatusTerminatedEvent struct{…}` Indicates the session has terminated, either due to an error or completion. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionStatusTerminatedEventType` - `const BetaManagedAgentsSessionStatusTerminatedEventTypeSessionStatusTerminated BetaManagedAgentsSessionStatusTerminatedEventType = "session.status_terminated"` ### Beta Managed Agents Session Thread Created Event - `type BetaManagedAgentsSessionThreadCreatedEvent struct{…}` Emitted when a subagent is spawned as a new thread. Written to the parent thread's output stream so clients observing the session see child creation. - `ID string` Unique identifier for this event. - `AgentName string` Name of the callable agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public `sthr_` ID of the newly created thread. - `Type BetaManagedAgentsSessionThreadCreatedEventType` - `const BetaManagedAgentsSessionThreadCreatedEventTypeSessionThreadCreated BetaManagedAgentsSessionThreadCreatedEventType = "session.thread_created"` ### Beta Managed Agents Session Thread Status Idle Event - `type BetaManagedAgentsSessionThreadStatusIdleEvent struct{…}` A session thread has yielded and is awaiting input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that went idle. - `StopReason BetaManagedAgentsSessionThreadStatusIdleEventStopReasonUnion` The agent completed its turn naturally and is ready for the next user message. - `type BetaManagedAgentsSessionEndTurn struct{…}` The agent completed its turn naturally and is ready for the next user message. - `Type BetaManagedAgentsSessionEndTurnType` - `const BetaManagedAgentsSessionEndTurnTypeEndTurn BetaManagedAgentsSessionEndTurnType = "end_turn"` - `type BetaManagedAgentsSessionRequiresAction struct{…}` The agent is idle waiting on one or more blocking user-input events (tool confirmation, custom tool result, etc.). Resolving all of them transitions the session back to running. - `EventIDs []string` The ids of events the agent is blocked on. Resolving fewer than all re-emits `session.status_idle` with the remainder. - `Type BetaManagedAgentsSessionRequiresActionType` - `const BetaManagedAgentsSessionRequiresActionTypeRequiresAction BetaManagedAgentsSessionRequiresActionType = "requires_action"` - `type BetaManagedAgentsSessionRetriesExhausted struct{…}` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `Type BetaManagedAgentsSessionRetriesExhaustedType` - `const BetaManagedAgentsSessionRetriesExhaustedTypeRetriesExhausted BetaManagedAgentsSessionRetriesExhaustedType = "retries_exhausted"` - `Type BetaManagedAgentsSessionThreadStatusIdleEventType` - `const BetaManagedAgentsSessionThreadStatusIdleEventTypeSessionThreadStatusIdle BetaManagedAgentsSessionThreadStatusIdleEventType = "session.thread_status_idle"` ### Beta Managed Agents Session Thread Status Rescheduled Event - `type BetaManagedAgentsSessionThreadStatusRescheduledEvent struct{…}` A session thread hit a transient error and is retrying automatically. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that is retrying. - `Type BetaManagedAgentsSessionThreadStatusRescheduledEventType` - `const BetaManagedAgentsSessionThreadStatusRescheduledEventTypeSessionThreadStatusRescheduled BetaManagedAgentsSessionThreadStatusRescheduledEventType = "session.thread_status_rescheduled"` ### Beta Managed Agents Session Thread Status Running Event - `type BetaManagedAgentsSessionThreadStatusRunningEvent struct{…}` A session thread has begun executing. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that started running. - `Type BetaManagedAgentsSessionThreadStatusRunningEventType` - `const BetaManagedAgentsSessionThreadStatusRunningEventTypeSessionThreadStatusRunning BetaManagedAgentsSessionThreadStatusRunningEventType = "session.thread_status_running"` ### Beta Managed Agents Session Thread Status Terminated Event - `type BetaManagedAgentsSessionThreadStatusTerminatedEvent struct{…}` A session thread has terminated and will accept no further input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that terminated. - `Type BetaManagedAgentsSessionThreadStatusTerminatedEventType` - `const BetaManagedAgentsSessionThreadStatusTerminatedEventTypeSessionThreadStatusTerminated BetaManagedAgentsSessionThreadStatusTerminatedEventType = "session.thread_status_terminated"` ### Beta Managed Agents Span Model Request End Event - `type BetaManagedAgentsSpanModelRequestEndEvent struct{…}` Emitted when a model request completes. - `ID string` Unique identifier for this event. - `IsError bool` Whether the model request resulted in an error. - `ModelRequestStartID string` The id of the corresponding `span.model_request_start` event. - `ModelUsage BetaManagedAgentsSpanModelUsage` Token usage for a single model request. - `CacheCreationInputTokens int64` Tokens used to create prompt cache in this request. - `CacheReadInputTokens int64` Tokens read from prompt cache in this request. - `InputTokens int64` Input tokens consumed by this request. - `OutputTokens int64` Output tokens generated by this request. - `Speed BetaManagedAgentsSpanModelUsageSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsSpanModelUsageSpeedStandard BetaManagedAgentsSpanModelUsageSpeed = "standard"` - `const BetaManagedAgentsSpanModelUsageSpeedFast BetaManagedAgentsSpanModelUsageSpeed = "fast"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanModelRequestEndEventType` - `const BetaManagedAgentsSpanModelRequestEndEventTypeSpanModelRequestEnd BetaManagedAgentsSpanModelRequestEndEventType = "span.model_request_end"` ### Beta Managed Agents Span Model Request Start Event - `type BetaManagedAgentsSpanModelRequestStartEvent struct{…}` Emitted when a model request is initiated by the agent. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanModelRequestStartEventType` - `const BetaManagedAgentsSpanModelRequestStartEventTypeSpanModelRequestStart BetaManagedAgentsSpanModelRequestStartEventType = "span.model_request_start"` ### Beta Managed Agents Span Model Usage - `type BetaManagedAgentsSpanModelUsage struct{…}` Token usage for a single model request. - `CacheCreationInputTokens int64` Tokens used to create prompt cache in this request. - `CacheReadInputTokens int64` Tokens read from prompt cache in this request. - `InputTokens int64` Input tokens consumed by this request. - `OutputTokens int64` Output tokens generated by this request. - `Speed BetaManagedAgentsSpanModelUsageSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsSpanModelUsageSpeedStandard BetaManagedAgentsSpanModelUsageSpeed = "standard"` - `const BetaManagedAgentsSpanModelUsageSpeedFast BetaManagedAgentsSpanModelUsageSpeed = "fast"` ### Beta Managed Agents Span Outcome Evaluation End Event - `type BetaManagedAgentsSpanOutcomeEvaluationEndEvent struct{…}` Emitted when an outcome evaluation cycle completes. Carries the verdict and aggregate token usage. A verdict of `needs_revision` means another evaluation cycle follows; `satisfied`, `max_iterations_reached`, `failed`, or `interrupted` are terminal — no further evaluation cycles follow. - `ID string` Unique identifier for this event. - `Explanation string` Human-readable explanation of the verdict. For `needs_revision`, describes which criteria failed and why. - `Iteration int64` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `OutcomeEvaluationStartID string` The id of the corresponding `span.outcome_evaluation_start` event. - `OutcomeID string` The `outc_` ID of the outcome being evaluated. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Result string` Evaluation verdict. 'satisfied': criteria met, session goes idle. 'needs_revision': criteria not met, another revision cycle follows. 'max_iterations_reached': evaluation budget exhausted with criteria still unmet — one final acknowledgment turn follows before the session goes idle, but no further evaluation runs. 'failed': grader determined the rubric does not apply to the deliverables. 'interrupted': user sent an interrupt while evaluation was in progress. - `Type BetaManagedAgentsSpanOutcomeEvaluationEndEventType` - `const BetaManagedAgentsSpanOutcomeEvaluationEndEventTypeSpanOutcomeEvaluationEnd BetaManagedAgentsSpanOutcomeEvaluationEndEventType = "span.outcome_evaluation_end"` - `Usage BetaManagedAgentsSpanModelUsage` Token usage for a single model request. - `CacheCreationInputTokens int64` Tokens used to create prompt cache in this request. - `CacheReadInputTokens int64` Tokens read from prompt cache in this request. - `InputTokens int64` Input tokens consumed by this request. - `OutputTokens int64` Output tokens generated by this request. - `Speed BetaManagedAgentsSpanModelUsageSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsSpanModelUsageSpeedStandard BetaManagedAgentsSpanModelUsageSpeed = "standard"` - `const BetaManagedAgentsSpanModelUsageSpeedFast BetaManagedAgentsSpanModelUsageSpeed = "fast"` ### Beta Managed Agents Span Outcome Evaluation Ongoing Event - `type BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent struct{…}` Periodic heartbeat emitted while an outcome evaluation cycle is in progress. Distinguishes 'evaluation is actively running' from 'evaluation is stuck' between the corresponding `span.outcome_evaluation_start` and `span.outcome_evaluation_end` events. - `ID string` Unique identifier for this event. - `Iteration int64` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `OutcomeID string` The `outc_` ID of the outcome being evaluated. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanOutcomeEvaluationOngoingEventType` - `const BetaManagedAgentsSpanOutcomeEvaluationOngoingEventTypeSpanOutcomeEvaluationOngoing BetaManagedAgentsSpanOutcomeEvaluationOngoingEventType = "span.outcome_evaluation_ongoing"` ### Beta Managed Agents Span Outcome Evaluation Start Event - `type BetaManagedAgentsSpanOutcomeEvaluationStartEvent struct{…}` Emitted when an outcome evaluation cycle begins. - `ID string` Unique identifier for this event. - `Iteration int64` 0-indexed revision cycle. 0 is the first evaluation; 1 is the re-evaluation after the first revision; etc. - `OutcomeID string` The `outc_` ID of the outcome being evaluated. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanOutcomeEvaluationStartEventType` - `const BetaManagedAgentsSpanOutcomeEvaluationStartEventTypeSpanOutcomeEvaluationStart BetaManagedAgentsSpanOutcomeEvaluationStartEventType = "span.outcome_evaluation_start"` ### Beta Managed Agents Stream Session Events - `type BetaManagedAgentsStreamSessionEventsUnion interface{…}` Server-sent event in the session stream. - `type BetaManagedAgentsUserMessageEvent struct{…}` A user message event in the session conversation. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsUserMessageEventContentUnion` Array of content blocks comprising the user message. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `const BetaManagedAgentsTextBlockTypeText BetaManagedAgentsTextBlockType = "text"` - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `Source BetaManagedAgentsImageBlockSourceUnion` Union type for image source variants. - `type BetaManagedAgentsBase64ImageSource struct{…}` Base64-encoded image data. - `Data string` Base64-encoded image data. - `MediaType string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `Type BetaManagedAgentsBase64ImageSourceType` - `const BetaManagedAgentsBase64ImageSourceTypeBase64 BetaManagedAgentsBase64ImageSourceType = "base64"` - `type BetaManagedAgentsURLImageSource struct{…}` Image referenced by URL. - `Type BetaManagedAgentsURLImageSourceType` - `const BetaManagedAgentsURLImageSourceTypeURL BetaManagedAgentsURLImageSourceType = "url"` - `URL string` URL of the image to fetch. - `type BetaManagedAgentsFileImageSource struct{…}` Image referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileImageSourceType` - `const BetaManagedAgentsFileImageSourceTypeFile BetaManagedAgentsFileImageSourceType = "file"` - `Type BetaManagedAgentsImageBlockType` - `const BetaManagedAgentsImageBlockTypeImage BetaManagedAgentsImageBlockType = "image"` - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `Source BetaManagedAgentsDocumentBlockSourceUnion` Union type for document source variants. - `type BetaManagedAgentsBase64DocumentSource struct{…}` Base64-encoded document data. - `Data string` Base64-encoded document data. - `MediaType string` MIME type of the document (e.g., "application/pdf"). - `Type BetaManagedAgentsBase64DocumentSourceType` - `const BetaManagedAgentsBase64DocumentSourceTypeBase64 BetaManagedAgentsBase64DocumentSourceType = "base64"` - `type BetaManagedAgentsPlainTextDocumentSource struct{…}` Plain text document content. - `Data string` The plain text content. - `MediaType BetaManagedAgentsPlainTextDocumentSourceMediaType` MIME type of the text content. Must be "text/plain". - `const BetaManagedAgentsPlainTextDocumentSourceMediaTypeTextPlain BetaManagedAgentsPlainTextDocumentSourceMediaType = "text/plain"` - `Type BetaManagedAgentsPlainTextDocumentSourceType` - `const BetaManagedAgentsPlainTextDocumentSourceTypeText BetaManagedAgentsPlainTextDocumentSourceType = "text"` - `type BetaManagedAgentsURLDocumentSource struct{…}` Document referenced by URL. - `Type BetaManagedAgentsURLDocumentSourceType` - `const BetaManagedAgentsURLDocumentSourceTypeURL BetaManagedAgentsURLDocumentSourceType = "url"` - `URL string` URL of the document to fetch. - `type BetaManagedAgentsFileDocumentSource struct{…}` Document referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileDocumentSourceType` - `const BetaManagedAgentsFileDocumentSourceTypeFile BetaManagedAgentsFileDocumentSourceType = "file"` - `Type BetaManagedAgentsDocumentBlockType` - `const BetaManagedAgentsDocumentBlockTypeDocument BetaManagedAgentsDocumentBlockType = "document"` - `Context string` Additional context about the document for the model. - `Title string` The title of the document. - `Type BetaManagedAgentsUserMessageEventType` - `const BetaManagedAgentsUserMessageEventTypeUserMessage BetaManagedAgentsUserMessageEventType = "user.message"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `type BetaManagedAgentsUserInterruptEvent struct{…}` An interrupt event that pauses agent execution and returns control to the user. - `ID string` Unique identifier for this event. - `Type BetaManagedAgentsUserInterruptEventType` - `const BetaManagedAgentsUserInterruptEventTypeUserInterrupt BetaManagedAgentsUserInterruptEventType = "user.interrupt"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. - `type BetaManagedAgentsUserToolConfirmationEvent struct{…}` A tool confirmation event that approves or denies a pending tool execution. - `ID string` Unique identifier for this event. - `Result BetaManagedAgentsUserToolConfirmationEventResult` UserToolConfirmationResult enum - `const BetaManagedAgentsUserToolConfirmationEventResultAllow BetaManagedAgentsUserToolConfirmationEventResult = "allow"` - `const BetaManagedAgentsUserToolConfirmationEventResultDeny BetaManagedAgentsUserToolConfirmationEventResult = "deny"` - `ToolUseID string` The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserToolConfirmationEventType` - `const BetaManagedAgentsUserToolConfirmationEventTypeUserToolConfirmation BetaManagedAgentsUserToolConfirmationEventType = "user.tool_confirmation"` - `DenyMessage string` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` When set, the confirmation routes to this subagent's thread rather than the primary. Echo this from the `session_thread_id` on the `agent.tool_use` or `agent.mcp_tool_use` event that prompted the approval. - `type BetaManagedAgentsUserCustomToolResultEvent struct{…}` Event sent by the client providing the result of a custom tool execution. - `ID string` Unique identifier for this event. - `CustomToolUseID string` The id of the `agent.custom_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserCustomToolResultEventType` - `const BetaManagedAgentsUserCustomToolResultEventTypeUserCustomToolResult BetaManagedAgentsUserCustomToolResultEventType = "user.custom_tool_result"` - `Content []BetaManagedAgentsUserCustomToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `Citations BetaManagedAgentsSearchResultCitations` Citation settings for a search result. - `Enabled bool` Whether citations are enabled for this search result. - `Content []BetaManagedAgentsSearchResultContent` Array of text content blocks from the search result. - `Text string` The text content. - `Type BetaManagedAgentsSearchResultContentType` - `const BetaManagedAgentsSearchResultContentTypeText BetaManagedAgentsSearchResultContentType = "text"` - `Source string` The URL source of the search result. - `Title string` The title of the search result. - `Type BetaManagedAgentsSearchResultBlockType` - `const BetaManagedAgentsSearchResultBlockTypeSearchResult BetaManagedAgentsSearchResultBlockType = "search_result"` - `IsError bool` Whether the tool execution resulted in an error. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Routes this result to a subagent thread. Copy from the `agent.custom_tool_use` event's `session_thread_id`. - `type BetaManagedAgentsAgentCustomToolUseEvent struct{…}` Event emitted when the agent calls a custom tool. The session goes idle until the client sends a `user.custom_tool_result` event with the result. - `ID string` Unique identifier for this event. - `Input map[string, any]` Input parameters for the tool call. - `Name string` Name of the custom tool being called. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentCustomToolUseEventType` - `const BetaManagedAgentsAgentCustomToolUseEventTypeAgentCustomToolUse BetaManagedAgentsAgentCustomToolUseEventType = "agent.custom_tool_use"` - `SessionThreadID string` When set, this event was cross-posted from a subagent's thread to surface its custom tool use on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.custom_tool_result` event to route the result back. - `type BetaManagedAgentsAgentMessageEvent struct{…}` An agent response event in the session conversation. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsTextBlock` Array of text blocks comprising the agent response. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentMessageEventType` - `const BetaManagedAgentsAgentMessageEventTypeAgentMessage BetaManagedAgentsAgentMessageEventType = "agent.message"` - `type BetaManagedAgentsAgentThinkingEvent struct{…}` Indicates the agent is making forward progress via extended thinking. A progress signal, not a content carrier. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentThinkingEventType` - `const BetaManagedAgentsAgentThinkingEventTypeAgentThinking BetaManagedAgentsAgentThinkingEventType = "agent.thinking"` - `type BetaManagedAgentsAgentMCPToolUseEvent struct{…}` Event emitted when the agent invokes a tool provided by an MCP server. - `ID string` Unique identifier for this event. - `Input map[string, any]` Input parameters for the tool call. - `MCPServerName string` Name of the MCP server providing the tool. - `Name string` Name of the MCP tool being used. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentMCPToolUseEventType` - `const BetaManagedAgentsAgentMCPToolUseEventTypeAgentMCPToolUse BetaManagedAgentsAgentMCPToolUseEventType = "agent.mcp_tool_use"` - `EvaluatedPermission BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission` AgentEvaluatedPermission enum - `const BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermissionAllow BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission = "allow"` - `const BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermissionAsk BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission = "ask"` - `const BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermissionDeny BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission = "deny"` - `SessionThreadID string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `type BetaManagedAgentsAgentMCPToolResultEvent struct{…}` Event representing the result of an MCP tool execution. - `ID string` Unique identifier for this event. - `MCPToolUseID string` The id of the `agent.mcp_tool_use` event this result corresponds to. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentMCPToolResultEventType` - `const BetaManagedAgentsAgentMCPToolResultEventTypeAgentMCPToolResult BetaManagedAgentsAgentMCPToolResultEventType = "agent.mcp_tool_result"` - `Content []BetaManagedAgentsAgentMCPToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `IsError bool` Whether the tool execution resulted in an error. - `type BetaManagedAgentsAgentToolUseEvent struct{…}` Event emitted when the agent invokes a built-in agent tool. - `ID string` Unique identifier for this event. - `Input map[string, any]` Input parameters for the tool call. - `Name string` Name of the agent tool being used. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentToolUseEventType` - `const BetaManagedAgentsAgentToolUseEventTypeAgentToolUse BetaManagedAgentsAgentToolUseEventType = "agent.tool_use"` - `EvaluatedPermission BetaManagedAgentsAgentToolUseEventEvaluatedPermission` AgentEvaluatedPermission enum - `const BetaManagedAgentsAgentToolUseEventEvaluatedPermissionAllow BetaManagedAgentsAgentToolUseEventEvaluatedPermission = "allow"` - `const BetaManagedAgentsAgentToolUseEventEvaluatedPermissionAsk BetaManagedAgentsAgentToolUseEventEvaluatedPermission = "ask"` - `const BetaManagedAgentsAgentToolUseEventEvaluatedPermissionDeny BetaManagedAgentsAgentToolUseEventEvaluatedPermission = "deny"` - `SessionThreadID string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `type BetaManagedAgentsAgentToolResultEvent struct{…}` Event representing the result of an agent tool execution. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `ToolUseID string` The id of the `agent.tool_use` event this result corresponds to. - `Type BetaManagedAgentsAgentToolResultEventType` - `const BetaManagedAgentsAgentToolResultEventTypeAgentToolResult BetaManagedAgentsAgentToolResultEventType = "agent.tool_result"` - `Content []BetaManagedAgentsAgentToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `IsError bool` Whether the tool execution resulted in an error. - `type BetaManagedAgentsAgentThreadMessageReceivedEvent struct{…}` Delivery event written to the target thread's input stream when an agent-to-agent message arrives. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsAgentThreadMessageReceivedEventContentUnion` Message content blocks. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `FromSessionThreadID string` Public `sthr_` ID of the thread that sent the message. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentThreadMessageReceivedEventType` - `const BetaManagedAgentsAgentThreadMessageReceivedEventTypeAgentThreadMessageReceived BetaManagedAgentsAgentThreadMessageReceivedEventType = "agent.thread_message_received"` - `FromAgentName string` Name of the callable agent this message came from. Absent when received from the primary agent. - `type BetaManagedAgentsAgentThreadMessageSentEvent struct{…}` Observability event emitted to the sender's output stream when an agent-to-agent message is sent. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsAgentThreadMessageSentEventContentUnion` Message content blocks. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `ProcessedAt Time` A timestamp in RFC 3339 format - `ToSessionThreadID string` Public `sthr_` ID of the thread the message was sent to. - `Type BetaManagedAgentsAgentThreadMessageSentEventType` - `const BetaManagedAgentsAgentThreadMessageSentEventTypeAgentThreadMessageSent BetaManagedAgentsAgentThreadMessageSentEventType = "agent.thread_message_sent"` - `ToAgentName string` Name of the callable agent this message was sent to. Absent when sent to the primary agent. - `type BetaManagedAgentsAgentThreadContextCompactedEvent struct{…}` Indicates that context compaction (summarization) occurred during the session. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentThreadContextCompactedEventType` - `const BetaManagedAgentsAgentThreadContextCompactedEventTypeAgentThreadContextCompacted BetaManagedAgentsAgentThreadContextCompactedEventType = "agent.thread_context_compacted"` - `type BetaManagedAgentsSessionErrorEvent struct{…}` An error event indicating a problem occurred during session execution. - `ID string` Unique identifier for this event. - `Error BetaManagedAgentsSessionErrorEventErrorUnion` An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on `retry_status` and `message` alone. - `type BetaManagedAgentsUnknownError struct{…}` An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on `retry_status` and `message` alone. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsUnknownErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `Type BetaManagedAgentsRetryStatusRetryingType` - `const BetaManagedAgentsRetryStatusRetryingTypeRetrying BetaManagedAgentsRetryStatusRetryingType = "retrying"` - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `Type BetaManagedAgentsRetryStatusExhaustedType` - `const BetaManagedAgentsRetryStatusExhaustedTypeExhausted BetaManagedAgentsRetryStatusExhaustedType = "exhausted"` - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsRetryStatusTerminalType` - `const BetaManagedAgentsRetryStatusTerminalTypeTerminal BetaManagedAgentsRetryStatusTerminalType = "terminal"` - `Type BetaManagedAgentsUnknownErrorType` - `const BetaManagedAgentsUnknownErrorTypeUnknownError BetaManagedAgentsUnknownErrorType = "unknown_error"` - `type BetaManagedAgentsModelOverloadedError struct{…}` The model is currently overloaded. Emitted after automatic retries are exhausted. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsModelOverloadedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsModelOverloadedErrorType` - `const BetaManagedAgentsModelOverloadedErrorTypeModelOverloadedError BetaManagedAgentsModelOverloadedErrorType = "model_overloaded_error"` - `type BetaManagedAgentsModelRateLimitedError struct{…}` The model request was rate-limited. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsModelRateLimitedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsModelRateLimitedErrorType` - `const BetaManagedAgentsModelRateLimitedErrorTypeModelRateLimitedError BetaManagedAgentsModelRateLimitedErrorType = "model_rate_limited_error"` - `type BetaManagedAgentsModelRequestFailedError struct{…}` A model request failed for a reason other than overload or rate-limiting. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsModelRequestFailedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsModelRequestFailedErrorType` - `const BetaManagedAgentsModelRequestFailedErrorTypeModelRequestFailedError BetaManagedAgentsModelRequestFailedErrorType = "model_request_failed_error"` - `type BetaManagedAgentsMCPConnectionFailedError struct{…}` Failed to connect to an MCP server. - `MCPServerName string` Name of the MCP server that failed to connect. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsMCPConnectionFailedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsMCPConnectionFailedErrorType` - `const BetaManagedAgentsMCPConnectionFailedErrorTypeMCPConnectionFailedError BetaManagedAgentsMCPConnectionFailedErrorType = "mcp_connection_failed_error"` - `type BetaManagedAgentsMCPAuthenticationFailedError struct{…}` Authentication to an MCP server failed. - `MCPServerName string` Name of the MCP server that failed authentication. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsMCPAuthenticationFailedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsMCPAuthenticationFailedErrorType` - `const BetaManagedAgentsMCPAuthenticationFailedErrorTypeMCPAuthenticationFailedError BetaManagedAgentsMCPAuthenticationFailedErrorType = "mcp_authentication_failed_error"` - `type BetaManagedAgentsBillingError struct{…}` The caller's organization or workspace cannot make model requests — out of credits or spend limit reached. Retrying with the same credentials will not succeed; the caller must resolve the billing state. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsBillingErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsBillingErrorType` - `const BetaManagedAgentsBillingErrorTypeBillingError BetaManagedAgentsBillingErrorType = "billing_error"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionErrorEventType` - `const BetaManagedAgentsSessionErrorEventTypeSessionError BetaManagedAgentsSessionErrorEventType = "session.error"` - `type BetaManagedAgentsSessionStatusRescheduledEvent struct{…}` Indicates the session is recovering from an error state and is rescheduled for execution. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionStatusRescheduledEventType` - `const BetaManagedAgentsSessionStatusRescheduledEventTypeSessionStatusRescheduled BetaManagedAgentsSessionStatusRescheduledEventType = "session.status_rescheduled"` - `type BetaManagedAgentsSessionStatusRunningEvent struct{…}` Indicates the session is actively running and the agent is working. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionStatusRunningEventType` - `const BetaManagedAgentsSessionStatusRunningEventTypeSessionStatusRunning BetaManagedAgentsSessionStatusRunningEventType = "session.status_running"` - `type BetaManagedAgentsSessionStatusIdleEvent struct{…}` Indicates the agent has paused and is awaiting user input. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `StopReason BetaManagedAgentsSessionStatusIdleEventStopReasonUnion` The agent completed its turn naturally and is ready for the next user message. - `type BetaManagedAgentsSessionEndTurn struct{…}` The agent completed its turn naturally and is ready for the next user message. - `Type BetaManagedAgentsSessionEndTurnType` - `const BetaManagedAgentsSessionEndTurnTypeEndTurn BetaManagedAgentsSessionEndTurnType = "end_turn"` - `type BetaManagedAgentsSessionRequiresAction struct{…}` The agent is idle waiting on one or more blocking user-input events (tool confirmation, custom tool result, etc.). Resolving all of them transitions the session back to running. - `EventIDs []string` The ids of events the agent is blocked on. Resolving fewer than all re-emits `session.status_idle` with the remainder. - `Type BetaManagedAgentsSessionRequiresActionType` - `const BetaManagedAgentsSessionRequiresActionTypeRequiresAction BetaManagedAgentsSessionRequiresActionType = "requires_action"` - `type BetaManagedAgentsSessionRetriesExhausted struct{…}` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `Type BetaManagedAgentsSessionRetriesExhaustedType` - `const BetaManagedAgentsSessionRetriesExhaustedTypeRetriesExhausted BetaManagedAgentsSessionRetriesExhaustedType = "retries_exhausted"` - `Type BetaManagedAgentsSessionStatusIdleEventType` - `const BetaManagedAgentsSessionStatusIdleEventTypeSessionStatusIdle BetaManagedAgentsSessionStatusIdleEventType = "session.status_idle"` - `type BetaManagedAgentsSessionStatusTerminatedEvent struct{…}` Indicates the session has terminated, either due to an error or completion. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionStatusTerminatedEventType` - `const BetaManagedAgentsSessionStatusTerminatedEventTypeSessionStatusTerminated BetaManagedAgentsSessionStatusTerminatedEventType = "session.status_terminated"` - `type BetaManagedAgentsSessionThreadCreatedEvent struct{…}` Emitted when a subagent is spawned as a new thread. Written to the parent thread's output stream so clients observing the session see child creation. - `ID string` Unique identifier for this event. - `AgentName string` Name of the callable agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public `sthr_` ID of the newly created thread. - `Type BetaManagedAgentsSessionThreadCreatedEventType` - `const BetaManagedAgentsSessionThreadCreatedEventTypeSessionThreadCreated BetaManagedAgentsSessionThreadCreatedEventType = "session.thread_created"` - `type BetaManagedAgentsSpanOutcomeEvaluationStartEvent struct{…}` Emitted when an outcome evaluation cycle begins. - `ID string` Unique identifier for this event. - `Iteration int64` 0-indexed revision cycle. 0 is the first evaluation; 1 is the re-evaluation after the first revision; etc. - `OutcomeID string` The `outc_` ID of the outcome being evaluated. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanOutcomeEvaluationStartEventType` - `const BetaManagedAgentsSpanOutcomeEvaluationStartEventTypeSpanOutcomeEvaluationStart BetaManagedAgentsSpanOutcomeEvaluationStartEventType = "span.outcome_evaluation_start"` - `type BetaManagedAgentsSpanOutcomeEvaluationEndEvent struct{…}` Emitted when an outcome evaluation cycle completes. Carries the verdict and aggregate token usage. A verdict of `needs_revision` means another evaluation cycle follows; `satisfied`, `max_iterations_reached`, `failed`, or `interrupted` are terminal — no further evaluation cycles follow. - `ID string` Unique identifier for this event. - `Explanation string` Human-readable explanation of the verdict. For `needs_revision`, describes which criteria failed and why. - `Iteration int64` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `OutcomeEvaluationStartID string` The id of the corresponding `span.outcome_evaluation_start` event. - `OutcomeID string` The `outc_` ID of the outcome being evaluated. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Result string` Evaluation verdict. 'satisfied': criteria met, session goes idle. 'needs_revision': criteria not met, another revision cycle follows. 'max_iterations_reached': evaluation budget exhausted with criteria still unmet — one final acknowledgment turn follows before the session goes idle, but no further evaluation runs. 'failed': grader determined the rubric does not apply to the deliverables. 'interrupted': user sent an interrupt while evaluation was in progress. - `Type BetaManagedAgentsSpanOutcomeEvaluationEndEventType` - `const BetaManagedAgentsSpanOutcomeEvaluationEndEventTypeSpanOutcomeEvaluationEnd BetaManagedAgentsSpanOutcomeEvaluationEndEventType = "span.outcome_evaluation_end"` - `Usage BetaManagedAgentsSpanModelUsage` Token usage for a single model request. - `CacheCreationInputTokens int64` Tokens used to create prompt cache in this request. - `CacheReadInputTokens int64` Tokens read from prompt cache in this request. - `InputTokens int64` Input tokens consumed by this request. - `OutputTokens int64` Output tokens generated by this request. - `Speed BetaManagedAgentsSpanModelUsageSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsSpanModelUsageSpeedStandard BetaManagedAgentsSpanModelUsageSpeed = "standard"` - `const BetaManagedAgentsSpanModelUsageSpeedFast BetaManagedAgentsSpanModelUsageSpeed = "fast"` - `type BetaManagedAgentsSpanModelRequestStartEvent struct{…}` Emitted when a model request is initiated by the agent. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanModelRequestStartEventType` - `const BetaManagedAgentsSpanModelRequestStartEventTypeSpanModelRequestStart BetaManagedAgentsSpanModelRequestStartEventType = "span.model_request_start"` - `type BetaManagedAgentsSpanModelRequestEndEvent struct{…}` Emitted when a model request completes. - `ID string` Unique identifier for this event. - `IsError bool` Whether the model request resulted in an error. - `ModelRequestStartID string` The id of the corresponding `span.model_request_start` event. - `ModelUsage BetaManagedAgentsSpanModelUsage` Token usage for a single model request. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanModelRequestEndEventType` - `const BetaManagedAgentsSpanModelRequestEndEventTypeSpanModelRequestEnd BetaManagedAgentsSpanModelRequestEndEventType = "span.model_request_end"` - `type BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent struct{…}` Periodic heartbeat emitted while an outcome evaluation cycle is in progress. Distinguishes 'evaluation is actively running' from 'evaluation is stuck' between the corresponding `span.outcome_evaluation_start` and `span.outcome_evaluation_end` events. - `ID string` Unique identifier for this event. - `Iteration int64` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `OutcomeID string` The `outc_` ID of the outcome being evaluated. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanOutcomeEvaluationOngoingEventType` - `const BetaManagedAgentsSpanOutcomeEvaluationOngoingEventTypeSpanOutcomeEvaluationOngoing BetaManagedAgentsSpanOutcomeEvaluationOngoingEventType = "span.outcome_evaluation_ongoing"` - `type BetaManagedAgentsUserDefineOutcomeEvent struct{…}` Echo of a `user.define_outcome` input event. Carries the server-generated `outcome_id` that subsequent `span.outcome_evaluation_*` events reference. - `ID string` Unique identifier for this event. - `Description string` What the agent should produce. Copied from the input event. - `MaxIterations int64` Evaluate-then-revise cycles before giving up. Default 3, max 20. - `OutcomeID string` Server-generated `outc_` ID for this outcome. Referenced by `span.outcome_evaluation_*` events and the session's `outcome_evaluations` list. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Rubric BetaManagedAgentsUserDefineOutcomeEventRubricUnion` Rubric for grading the quality of an outcome. - `type BetaManagedAgentsFileRubric struct{…}` Rubric referenced by a file uploaded via the Files API. - `FileID string` ID of the rubric file. - `Type BetaManagedAgentsFileRubricType` - `const BetaManagedAgentsFileRubricTypeFile BetaManagedAgentsFileRubricType = "file"` - `type BetaManagedAgentsTextRubric struct{…}` Rubric content provided inline as text. - `Content string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `Type BetaManagedAgentsTextRubricType` - `const BetaManagedAgentsTextRubricTypeText BetaManagedAgentsTextRubricType = "text"` - `Type BetaManagedAgentsUserDefineOutcomeEventType` - `const BetaManagedAgentsUserDefineOutcomeEventTypeUserDefineOutcome BetaManagedAgentsUserDefineOutcomeEventType = "user.define_outcome"` - `type BetaManagedAgentsSessionDeletedEvent struct{…}` Emitted when a session has been deleted. Terminates any active event stream — no further events will be emitted for this session. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionDeletedEventType` - `const BetaManagedAgentsSessionDeletedEventTypeSessionDeleted BetaManagedAgentsSessionDeletedEventType = "session.deleted"` - `type BetaManagedAgentsSessionThreadStatusRunningEvent struct{…}` A session thread has begun executing. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that started running. - `Type BetaManagedAgentsSessionThreadStatusRunningEventType` - `const BetaManagedAgentsSessionThreadStatusRunningEventTypeSessionThreadStatusRunning BetaManagedAgentsSessionThreadStatusRunningEventType = "session.thread_status_running"` - `type BetaManagedAgentsSessionThreadStatusIdleEvent struct{…}` A session thread has yielded and is awaiting input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that went idle. - `StopReason BetaManagedAgentsSessionThreadStatusIdleEventStopReasonUnion` The agent completed its turn naturally and is ready for the next user message. - `type BetaManagedAgentsSessionEndTurn struct{…}` The agent completed its turn naturally and is ready for the next user message. - `type BetaManagedAgentsSessionRequiresAction struct{…}` The agent is idle waiting on one or more blocking user-input events (tool confirmation, custom tool result, etc.). Resolving all of them transitions the session back to running. - `type BetaManagedAgentsSessionRetriesExhausted struct{…}` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `Type BetaManagedAgentsSessionThreadStatusIdleEventType` - `const BetaManagedAgentsSessionThreadStatusIdleEventTypeSessionThreadStatusIdle BetaManagedAgentsSessionThreadStatusIdleEventType = "session.thread_status_idle"` - `type BetaManagedAgentsSessionThreadStatusTerminatedEvent struct{…}` A session thread has terminated and will accept no further input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that terminated. - `Type BetaManagedAgentsSessionThreadStatusTerminatedEventType` - `const BetaManagedAgentsSessionThreadStatusTerminatedEventTypeSessionThreadStatusTerminated BetaManagedAgentsSessionThreadStatusTerminatedEventType = "session.thread_status_terminated"` - `type BetaManagedAgentsUserToolResultEvent struct{…}` Event sent by the client providing the result of an agent-toolset tool execution. Only valid on `self_hosted` environments, where sandbox-routed tools are executed by the client rather than the server. - `ID string` Unique identifier for this event. - `ToolUseID string` The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserToolResultEventType` - `const BetaManagedAgentsUserToolResultEventTypeUserToolResult BetaManagedAgentsUserToolResultEventType = "user.tool_result"` - `Content []BetaManagedAgentsUserToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `IsError bool` Whether the tool execution resulted in an error. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Routes this result to a subagent thread. Copy from the `agent.tool_use` event's `session_thread_id`. - `type BetaManagedAgentsSessionThreadStatusRescheduledEvent struct{…}` A session thread hit a transient error and is retrying automatically. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that is retrying. - `Type BetaManagedAgentsSessionThreadStatusRescheduledEventType` - `const BetaManagedAgentsSessionThreadStatusRescheduledEventTypeSessionThreadStatusRescheduled BetaManagedAgentsSessionThreadStatusRescheduledEventType = "session.thread_status_rescheduled"` - `type BetaManagedAgentsSessionUpdatedEvent struct{…}` Emitted when an UpdateSession request changed at least one field. Carries only the fields that changed; absent fields were not part of the update. The new configuration applies from the next turn. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionUpdatedEventType` - `const BetaManagedAgentsSessionUpdatedEventTypeSessionUpdated BetaManagedAgentsSessionUpdatedEventType = "session.updated"` - `Agent BetaManagedAgentsSessionAgent` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Multiagent BetaManagedAgentsSessionMultiagentCoordinator` Resolved coordinator topology with full agent definitions for each roster member. - `Agents []BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `Name string` - `Skills []BetaManagedAgentsSessionThreadAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsSessionThreadAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsSessionThreadAgentType` - `const BetaManagedAgentsSessionThreadAgentTypeAgent BetaManagedAgentsSessionThreadAgentType = "agent"` - `Version int64` - `Type BetaManagedAgentsSessionMultiagentCoordinatorType` - `const BetaManagedAgentsSessionMultiagentCoordinatorTypeCoordinator BetaManagedAgentsSessionMultiagentCoordinatorType = "coordinator"` - `Name string` - `Skills []BetaManagedAgentsSessionAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `System string` - `Tools []BetaManagedAgentsSessionAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `type BetaManagedAgentsMCPToolset struct{…}` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Type BetaManagedAgentsSessionAgentType` - `const BetaManagedAgentsSessionAgentTypeAgent BetaManagedAgentsSessionAgentType = "agent"` - `Version int64` - `Metadata map[string, string]` The session's full metadata bag after the update. Present when the update set non-empty metadata; absent when metadata was unchanged or cleared to empty. - `Title string` The session's new title. Present only when the update changed it. ### Beta Managed Agents Text Block - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `const BetaManagedAgentsTextBlockTypeText BetaManagedAgentsTextBlockType = "text"` ### Beta Managed Agents Text Rubric - `type BetaManagedAgentsTextRubric struct{…}` Rubric content provided inline as text. - `Content string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `Type BetaManagedAgentsTextRubricType` - `const BetaManagedAgentsTextRubricTypeText BetaManagedAgentsTextRubricType = "text"` ### Beta Managed Agents Text Rubric Params - `type BetaManagedAgentsTextRubricParamsResp struct{…}` Rubric content provided inline as text. - `Content string` Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters. - `Type BetaManagedAgentsTextRubricParamsType` - `const BetaManagedAgentsTextRubricParamsTypeText BetaManagedAgentsTextRubricParamsType = "text"` ### Beta Managed Agents Unknown Error - `type BetaManagedAgentsUnknownError struct{…}` An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on `retry_status` and `message` alone. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsUnknownErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `Type BetaManagedAgentsRetryStatusRetryingType` - `const BetaManagedAgentsRetryStatusRetryingTypeRetrying BetaManagedAgentsRetryStatusRetryingType = "retrying"` - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `Type BetaManagedAgentsRetryStatusExhaustedType` - `const BetaManagedAgentsRetryStatusExhaustedTypeExhausted BetaManagedAgentsRetryStatusExhaustedType = "exhausted"` - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsRetryStatusTerminalType` - `const BetaManagedAgentsRetryStatusTerminalTypeTerminal BetaManagedAgentsRetryStatusTerminalType = "terminal"` - `Type BetaManagedAgentsUnknownErrorType` - `const BetaManagedAgentsUnknownErrorTypeUnknownError BetaManagedAgentsUnknownErrorType = "unknown_error"` ### Beta Managed Agents URL Document Source - `type BetaManagedAgentsURLDocumentSource struct{…}` Document referenced by URL. - `Type BetaManagedAgentsURLDocumentSourceType` - `const BetaManagedAgentsURLDocumentSourceTypeURL BetaManagedAgentsURLDocumentSourceType = "url"` - `URL string` URL of the document to fetch. ### Beta Managed Agents URL Image Source - `type BetaManagedAgentsURLImageSource struct{…}` Image referenced by URL. - `Type BetaManagedAgentsURLImageSourceType` - `const BetaManagedAgentsURLImageSourceTypeURL BetaManagedAgentsURLImageSourceType = "url"` - `URL string` URL of the image to fetch. ### Beta Managed Agents User Custom Tool Result Event - `type BetaManagedAgentsUserCustomToolResultEvent struct{…}` Event sent by the client providing the result of a custom tool execution. - `ID string` Unique identifier for this event. - `CustomToolUseID string` The id of the `agent.custom_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserCustomToolResultEventType` - `const BetaManagedAgentsUserCustomToolResultEventTypeUserCustomToolResult BetaManagedAgentsUserCustomToolResultEventType = "user.custom_tool_result"` - `Content []BetaManagedAgentsUserCustomToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `const BetaManagedAgentsTextBlockTypeText BetaManagedAgentsTextBlockType = "text"` - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `Source BetaManagedAgentsImageBlockSourceUnion` Union type for image source variants. - `type BetaManagedAgentsBase64ImageSource struct{…}` Base64-encoded image data. - `Data string` Base64-encoded image data. - `MediaType string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `Type BetaManagedAgentsBase64ImageSourceType` - `const BetaManagedAgentsBase64ImageSourceTypeBase64 BetaManagedAgentsBase64ImageSourceType = "base64"` - `type BetaManagedAgentsURLImageSource struct{…}` Image referenced by URL. - `Type BetaManagedAgentsURLImageSourceType` - `const BetaManagedAgentsURLImageSourceTypeURL BetaManagedAgentsURLImageSourceType = "url"` - `URL string` URL of the image to fetch. - `type BetaManagedAgentsFileImageSource struct{…}` Image referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileImageSourceType` - `const BetaManagedAgentsFileImageSourceTypeFile BetaManagedAgentsFileImageSourceType = "file"` - `Type BetaManagedAgentsImageBlockType` - `const BetaManagedAgentsImageBlockTypeImage BetaManagedAgentsImageBlockType = "image"` - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `Source BetaManagedAgentsDocumentBlockSourceUnion` Union type for document source variants. - `type BetaManagedAgentsBase64DocumentSource struct{…}` Base64-encoded document data. - `Data string` Base64-encoded document data. - `MediaType string` MIME type of the document (e.g., "application/pdf"). - `Type BetaManagedAgentsBase64DocumentSourceType` - `const BetaManagedAgentsBase64DocumentSourceTypeBase64 BetaManagedAgentsBase64DocumentSourceType = "base64"` - `type BetaManagedAgentsPlainTextDocumentSource struct{…}` Plain text document content. - `Data string` The plain text content. - `MediaType BetaManagedAgentsPlainTextDocumentSourceMediaType` MIME type of the text content. Must be "text/plain". - `const BetaManagedAgentsPlainTextDocumentSourceMediaTypeTextPlain BetaManagedAgentsPlainTextDocumentSourceMediaType = "text/plain"` - `Type BetaManagedAgentsPlainTextDocumentSourceType` - `const BetaManagedAgentsPlainTextDocumentSourceTypeText BetaManagedAgentsPlainTextDocumentSourceType = "text"` - `type BetaManagedAgentsURLDocumentSource struct{…}` Document referenced by URL. - `Type BetaManagedAgentsURLDocumentSourceType` - `const BetaManagedAgentsURLDocumentSourceTypeURL BetaManagedAgentsURLDocumentSourceType = "url"` - `URL string` URL of the document to fetch. - `type BetaManagedAgentsFileDocumentSource struct{…}` Document referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileDocumentSourceType` - `const BetaManagedAgentsFileDocumentSourceTypeFile BetaManagedAgentsFileDocumentSourceType = "file"` - `Type BetaManagedAgentsDocumentBlockType` - `const BetaManagedAgentsDocumentBlockTypeDocument BetaManagedAgentsDocumentBlockType = "document"` - `Context string` Additional context about the document for the model. - `Title string` The title of the document. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `Citations BetaManagedAgentsSearchResultCitations` Citation settings for a search result. - `Enabled bool` Whether citations are enabled for this search result. - `Content []BetaManagedAgentsSearchResultContent` Array of text content blocks from the search result. - `Text string` The text content. - `Type BetaManagedAgentsSearchResultContentType` - `const BetaManagedAgentsSearchResultContentTypeText BetaManagedAgentsSearchResultContentType = "text"` - `Source string` The URL source of the search result. - `Title string` The title of the search result. - `Type BetaManagedAgentsSearchResultBlockType` - `const BetaManagedAgentsSearchResultBlockTypeSearchResult BetaManagedAgentsSearchResultBlockType = "search_result"` - `IsError bool` Whether the tool execution resulted in an error. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Routes this result to a subagent thread. Copy from the `agent.custom_tool_use` event's `session_thread_id`. ### Beta Managed Agents User Custom Tool Result Event Params - `type BetaManagedAgentsUserCustomToolResultEventParamsResp struct{…}` Parameters for providing the result of a custom tool execution. - `CustomToolUseID string` The id of the `agent.custom_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserCustomToolResultEventParamsType` - `const BetaManagedAgentsUserCustomToolResultEventParamsTypeUserCustomToolResult BetaManagedAgentsUserCustomToolResultEventParamsType = "user.custom_tool_result"` - `Content []BetaManagedAgentsUserCustomToolResultEventParamsContentUnionResp` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `const BetaManagedAgentsTextBlockTypeText BetaManagedAgentsTextBlockType = "text"` - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `Source BetaManagedAgentsImageBlockSourceUnion` Union type for image source variants. - `type BetaManagedAgentsBase64ImageSource struct{…}` Base64-encoded image data. - `Data string` Base64-encoded image data. - `MediaType string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `Type BetaManagedAgentsBase64ImageSourceType` - `const BetaManagedAgentsBase64ImageSourceTypeBase64 BetaManagedAgentsBase64ImageSourceType = "base64"` - `type BetaManagedAgentsURLImageSource struct{…}` Image referenced by URL. - `Type BetaManagedAgentsURLImageSourceType` - `const BetaManagedAgentsURLImageSourceTypeURL BetaManagedAgentsURLImageSourceType = "url"` - `URL string` URL of the image to fetch. - `type BetaManagedAgentsFileImageSource struct{…}` Image referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileImageSourceType` - `const BetaManagedAgentsFileImageSourceTypeFile BetaManagedAgentsFileImageSourceType = "file"` - `Type BetaManagedAgentsImageBlockType` - `const BetaManagedAgentsImageBlockTypeImage BetaManagedAgentsImageBlockType = "image"` - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `Source BetaManagedAgentsDocumentBlockSourceUnion` Union type for document source variants. - `type BetaManagedAgentsBase64DocumentSource struct{…}` Base64-encoded document data. - `Data string` Base64-encoded document data. - `MediaType string` MIME type of the document (e.g., "application/pdf"). - `Type BetaManagedAgentsBase64DocumentSourceType` - `const BetaManagedAgentsBase64DocumentSourceTypeBase64 BetaManagedAgentsBase64DocumentSourceType = "base64"` - `type BetaManagedAgentsPlainTextDocumentSource struct{…}` Plain text document content. - `Data string` The plain text content. - `MediaType BetaManagedAgentsPlainTextDocumentSourceMediaType` MIME type of the text content. Must be "text/plain". - `const BetaManagedAgentsPlainTextDocumentSourceMediaTypeTextPlain BetaManagedAgentsPlainTextDocumentSourceMediaType = "text/plain"` - `Type BetaManagedAgentsPlainTextDocumentSourceType` - `const BetaManagedAgentsPlainTextDocumentSourceTypeText BetaManagedAgentsPlainTextDocumentSourceType = "text"` - `type BetaManagedAgentsURLDocumentSource struct{…}` Document referenced by URL. - `Type BetaManagedAgentsURLDocumentSourceType` - `const BetaManagedAgentsURLDocumentSourceTypeURL BetaManagedAgentsURLDocumentSourceType = "url"` - `URL string` URL of the document to fetch. - `type BetaManagedAgentsFileDocumentSource struct{…}` Document referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileDocumentSourceType` - `const BetaManagedAgentsFileDocumentSourceTypeFile BetaManagedAgentsFileDocumentSourceType = "file"` - `Type BetaManagedAgentsDocumentBlockType` - `const BetaManagedAgentsDocumentBlockTypeDocument BetaManagedAgentsDocumentBlockType = "document"` - `Context string` Additional context about the document for the model. - `Title string` The title of the document. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `Citations BetaManagedAgentsSearchResultCitations` Citation settings for a search result. - `Enabled bool` Whether citations are enabled for this search result. - `Content []BetaManagedAgentsSearchResultContent` Array of text content blocks from the search result. - `Text string` The text content. - `Type BetaManagedAgentsSearchResultContentType` - `const BetaManagedAgentsSearchResultContentTypeText BetaManagedAgentsSearchResultContentType = "text"` - `Source string` The URL source of the search result. - `Title string` The title of the search result. - `Type BetaManagedAgentsSearchResultBlockType` - `const BetaManagedAgentsSearchResultBlockTypeSearchResult BetaManagedAgentsSearchResultBlockType = "search_result"` - `IsError bool` Whether the tool execution resulted in an error. ### Beta Managed Agents User Define Outcome Event - `type BetaManagedAgentsUserDefineOutcomeEvent struct{…}` Echo of a `user.define_outcome` input event. Carries the server-generated `outcome_id` that subsequent `span.outcome_evaluation_*` events reference. - `ID string` Unique identifier for this event. - `Description string` What the agent should produce. Copied from the input event. - `MaxIterations int64` Evaluate-then-revise cycles before giving up. Default 3, max 20. - `OutcomeID string` Server-generated `outc_` ID for this outcome. Referenced by `span.outcome_evaluation_*` events and the session's `outcome_evaluations` list. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Rubric BetaManagedAgentsUserDefineOutcomeEventRubricUnion` Rubric for grading the quality of an outcome. - `type BetaManagedAgentsFileRubric struct{…}` Rubric referenced by a file uploaded via the Files API. - `FileID string` ID of the rubric file. - `Type BetaManagedAgentsFileRubricType` - `const BetaManagedAgentsFileRubricTypeFile BetaManagedAgentsFileRubricType = "file"` - `type BetaManagedAgentsTextRubric struct{…}` Rubric content provided inline as text. - `Content string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `Type BetaManagedAgentsTextRubricType` - `const BetaManagedAgentsTextRubricTypeText BetaManagedAgentsTextRubricType = "text"` - `Type BetaManagedAgentsUserDefineOutcomeEventType` - `const BetaManagedAgentsUserDefineOutcomeEventTypeUserDefineOutcome BetaManagedAgentsUserDefineOutcomeEventType = "user.define_outcome"` ### Beta Managed Agents User Define Outcome Event Params - `type BetaManagedAgentsUserDefineOutcomeEventParamsResp struct{…}` Parameters for defining an outcome the agent should work toward. The agent begins work on receipt. - `Description string` What the agent should produce. This is the task specification. - `Rubric BetaManagedAgentsUserDefineOutcomeEventParamsRubricUnionResp` Rubric for grading the quality of an outcome. - `type BetaManagedAgentsFileRubricParamsResp struct{…}` Rubric referenced by a file uploaded via the Files API. - `FileID string` ID of the rubric file. - `Type BetaManagedAgentsFileRubricParamsType` - `const BetaManagedAgentsFileRubricParamsTypeFile BetaManagedAgentsFileRubricParamsType = "file"` - `type BetaManagedAgentsTextRubricParamsResp struct{…}` Rubric content provided inline as text. - `Content string` Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters. - `Type BetaManagedAgentsTextRubricParamsType` - `const BetaManagedAgentsTextRubricParamsTypeText BetaManagedAgentsTextRubricParamsType = "text"` - `Type BetaManagedAgentsUserDefineOutcomeEventParamsType` - `const BetaManagedAgentsUserDefineOutcomeEventParamsTypeUserDefineOutcome BetaManagedAgentsUserDefineOutcomeEventParamsType = "user.define_outcome"` - `MaxIterations int64` Eval→revision cycles before giving up. Default 3, max 20. ### Beta Managed Agents User Interrupt Event - `type BetaManagedAgentsUserInterruptEvent struct{…}` An interrupt event that pauses agent execution and returns control to the user. - `ID string` Unique identifier for this event. - `Type BetaManagedAgentsUserInterruptEventType` - `const BetaManagedAgentsUserInterruptEventTypeUserInterrupt BetaManagedAgentsUserInterruptEventType = "user.interrupt"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. ### Beta Managed Agents User Interrupt Event Params - `type BetaManagedAgentsUserInterruptEventParamsResp struct{…}` Parameters for sending an interrupt to pause the agent. - `Type BetaManagedAgentsUserInterruptEventParamsType` - `const BetaManagedAgentsUserInterruptEventParamsTypeUserInterrupt BetaManagedAgentsUserInterruptEventParamsType = "user.interrupt"` - `SessionThreadID string` If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. ### Beta Managed Agents User Message Event - `type BetaManagedAgentsUserMessageEvent struct{…}` A user message event in the session conversation. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsUserMessageEventContentUnion` Array of content blocks comprising the user message. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `const BetaManagedAgentsTextBlockTypeText BetaManagedAgentsTextBlockType = "text"` - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `Source BetaManagedAgentsImageBlockSourceUnion` Union type for image source variants. - `type BetaManagedAgentsBase64ImageSource struct{…}` Base64-encoded image data. - `Data string` Base64-encoded image data. - `MediaType string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `Type BetaManagedAgentsBase64ImageSourceType` - `const BetaManagedAgentsBase64ImageSourceTypeBase64 BetaManagedAgentsBase64ImageSourceType = "base64"` - `type BetaManagedAgentsURLImageSource struct{…}` Image referenced by URL. - `Type BetaManagedAgentsURLImageSourceType` - `const BetaManagedAgentsURLImageSourceTypeURL BetaManagedAgentsURLImageSourceType = "url"` - `URL string` URL of the image to fetch. - `type BetaManagedAgentsFileImageSource struct{…}` Image referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileImageSourceType` - `const BetaManagedAgentsFileImageSourceTypeFile BetaManagedAgentsFileImageSourceType = "file"` - `Type BetaManagedAgentsImageBlockType` - `const BetaManagedAgentsImageBlockTypeImage BetaManagedAgentsImageBlockType = "image"` - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `Source BetaManagedAgentsDocumentBlockSourceUnion` Union type for document source variants. - `type BetaManagedAgentsBase64DocumentSource struct{…}` Base64-encoded document data. - `Data string` Base64-encoded document data. - `MediaType string` MIME type of the document (e.g., "application/pdf"). - `Type BetaManagedAgentsBase64DocumentSourceType` - `const BetaManagedAgentsBase64DocumentSourceTypeBase64 BetaManagedAgentsBase64DocumentSourceType = "base64"` - `type BetaManagedAgentsPlainTextDocumentSource struct{…}` Plain text document content. - `Data string` The plain text content. - `MediaType BetaManagedAgentsPlainTextDocumentSourceMediaType` MIME type of the text content. Must be "text/plain". - `const BetaManagedAgentsPlainTextDocumentSourceMediaTypeTextPlain BetaManagedAgentsPlainTextDocumentSourceMediaType = "text/plain"` - `Type BetaManagedAgentsPlainTextDocumentSourceType` - `const BetaManagedAgentsPlainTextDocumentSourceTypeText BetaManagedAgentsPlainTextDocumentSourceType = "text"` - `type BetaManagedAgentsURLDocumentSource struct{…}` Document referenced by URL. - `Type BetaManagedAgentsURLDocumentSourceType` - `const BetaManagedAgentsURLDocumentSourceTypeURL BetaManagedAgentsURLDocumentSourceType = "url"` - `URL string` URL of the document to fetch. - `type BetaManagedAgentsFileDocumentSource struct{…}` Document referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileDocumentSourceType` - `const BetaManagedAgentsFileDocumentSourceTypeFile BetaManagedAgentsFileDocumentSourceType = "file"` - `Type BetaManagedAgentsDocumentBlockType` - `const BetaManagedAgentsDocumentBlockTypeDocument BetaManagedAgentsDocumentBlockType = "document"` - `Context string` Additional context about the document for the model. - `Title string` The title of the document. - `Type BetaManagedAgentsUserMessageEventType` - `const BetaManagedAgentsUserMessageEventTypeUserMessage BetaManagedAgentsUserMessageEventType = "user.message"` - `ProcessedAt Time` A timestamp in RFC 3339 format ### Beta Managed Agents User Message Event Params - `type BetaManagedAgentsUserMessageEventParamsResp struct{…}` Parameters for sending a user message to the session. - `Content []BetaManagedAgentsUserMessageEventParamsContentUnionResp` Array of content blocks for the user message. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `const BetaManagedAgentsTextBlockTypeText BetaManagedAgentsTextBlockType = "text"` - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `Source BetaManagedAgentsImageBlockSourceUnion` Union type for image source variants. - `type BetaManagedAgentsBase64ImageSource struct{…}` Base64-encoded image data. - `Data string` Base64-encoded image data. - `MediaType string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `Type BetaManagedAgentsBase64ImageSourceType` - `const BetaManagedAgentsBase64ImageSourceTypeBase64 BetaManagedAgentsBase64ImageSourceType = "base64"` - `type BetaManagedAgentsURLImageSource struct{…}` Image referenced by URL. - `Type BetaManagedAgentsURLImageSourceType` - `const BetaManagedAgentsURLImageSourceTypeURL BetaManagedAgentsURLImageSourceType = "url"` - `URL string` URL of the image to fetch. - `type BetaManagedAgentsFileImageSource struct{…}` Image referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileImageSourceType` - `const BetaManagedAgentsFileImageSourceTypeFile BetaManagedAgentsFileImageSourceType = "file"` - `Type BetaManagedAgentsImageBlockType` - `const BetaManagedAgentsImageBlockTypeImage BetaManagedAgentsImageBlockType = "image"` - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `Source BetaManagedAgentsDocumentBlockSourceUnion` Union type for document source variants. - `type BetaManagedAgentsBase64DocumentSource struct{…}` Base64-encoded document data. - `Data string` Base64-encoded document data. - `MediaType string` MIME type of the document (e.g., "application/pdf"). - `Type BetaManagedAgentsBase64DocumentSourceType` - `const BetaManagedAgentsBase64DocumentSourceTypeBase64 BetaManagedAgentsBase64DocumentSourceType = "base64"` - `type BetaManagedAgentsPlainTextDocumentSource struct{…}` Plain text document content. - `Data string` The plain text content. - `MediaType BetaManagedAgentsPlainTextDocumentSourceMediaType` MIME type of the text content. Must be "text/plain". - `const BetaManagedAgentsPlainTextDocumentSourceMediaTypeTextPlain BetaManagedAgentsPlainTextDocumentSourceMediaType = "text/plain"` - `Type BetaManagedAgentsPlainTextDocumentSourceType` - `const BetaManagedAgentsPlainTextDocumentSourceTypeText BetaManagedAgentsPlainTextDocumentSourceType = "text"` - `type BetaManagedAgentsURLDocumentSource struct{…}` Document referenced by URL. - `Type BetaManagedAgentsURLDocumentSourceType` - `const BetaManagedAgentsURLDocumentSourceTypeURL BetaManagedAgentsURLDocumentSourceType = "url"` - `URL string` URL of the document to fetch. - `type BetaManagedAgentsFileDocumentSource struct{…}` Document referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileDocumentSourceType` - `const BetaManagedAgentsFileDocumentSourceTypeFile BetaManagedAgentsFileDocumentSourceType = "file"` - `Type BetaManagedAgentsDocumentBlockType` - `const BetaManagedAgentsDocumentBlockTypeDocument BetaManagedAgentsDocumentBlockType = "document"` - `Context string` Additional context about the document for the model. - `Title string` The title of the document. - `Type BetaManagedAgentsUserMessageEventParamsType` - `const BetaManagedAgentsUserMessageEventParamsTypeUserMessage BetaManagedAgentsUserMessageEventParamsType = "user.message"` ### Beta Managed Agents User Tool Confirmation Event - `type BetaManagedAgentsUserToolConfirmationEvent struct{…}` A tool confirmation event that approves or denies a pending tool execution. - `ID string` Unique identifier for this event. - `Result BetaManagedAgentsUserToolConfirmationEventResult` UserToolConfirmationResult enum - `const BetaManagedAgentsUserToolConfirmationEventResultAllow BetaManagedAgentsUserToolConfirmationEventResult = "allow"` - `const BetaManagedAgentsUserToolConfirmationEventResultDeny BetaManagedAgentsUserToolConfirmationEventResult = "deny"` - `ToolUseID string` The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserToolConfirmationEventType` - `const BetaManagedAgentsUserToolConfirmationEventTypeUserToolConfirmation BetaManagedAgentsUserToolConfirmationEventType = "user.tool_confirmation"` - `DenyMessage string` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` When set, the confirmation routes to this subagent's thread rather than the primary. Echo this from the `session_thread_id` on the `agent.tool_use` or `agent.mcp_tool_use` event that prompted the approval. ### Beta Managed Agents User Tool Confirmation Event Params - `type BetaManagedAgentsUserToolConfirmationEventParamsResp struct{…}` Parameters for confirming or denying a tool execution request. - `Result BetaManagedAgentsUserToolConfirmationEventParamsResult` UserToolConfirmationResult enum - `const BetaManagedAgentsUserToolConfirmationEventParamsResultAllow BetaManagedAgentsUserToolConfirmationEventParamsResult = "allow"` - `const BetaManagedAgentsUserToolConfirmationEventParamsResultDeny BetaManagedAgentsUserToolConfirmationEventParamsResult = "deny"` - `ToolUseID string` The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserToolConfirmationEventParamsType` - `const BetaManagedAgentsUserToolConfirmationEventParamsTypeUserToolConfirmation BetaManagedAgentsUserToolConfirmationEventParamsType = "user.tool_confirmation"` - `DenyMessage string` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. ### Beta Managed Agents User Tool Result Event Params - `type BetaManagedAgentsUserToolResultEventParamsResp struct{…}` Parameters for providing the result of an agent-toolset tool execution. Only valid on `self_hosted` environments, where sandbox-routed tools are executed by the client rather than the server. - `ToolUseID string` The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserToolResultEventParamsType` - `const BetaManagedAgentsUserToolResultEventParamsTypeUserToolResult BetaManagedAgentsUserToolResultEventParamsType = "user.tool_result"` - `Content []BetaManagedAgentsUserToolResultEventParamsContentUnionResp` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `const BetaManagedAgentsTextBlockTypeText BetaManagedAgentsTextBlockType = "text"` - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `Source BetaManagedAgentsImageBlockSourceUnion` Union type for image source variants. - `type BetaManagedAgentsBase64ImageSource struct{…}` Base64-encoded image data. - `Data string` Base64-encoded image data. - `MediaType string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `Type BetaManagedAgentsBase64ImageSourceType` - `const BetaManagedAgentsBase64ImageSourceTypeBase64 BetaManagedAgentsBase64ImageSourceType = "base64"` - `type BetaManagedAgentsURLImageSource struct{…}` Image referenced by URL. - `Type BetaManagedAgentsURLImageSourceType` - `const BetaManagedAgentsURLImageSourceTypeURL BetaManagedAgentsURLImageSourceType = "url"` - `URL string` URL of the image to fetch. - `type BetaManagedAgentsFileImageSource struct{…}` Image referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileImageSourceType` - `const BetaManagedAgentsFileImageSourceTypeFile BetaManagedAgentsFileImageSourceType = "file"` - `Type BetaManagedAgentsImageBlockType` - `const BetaManagedAgentsImageBlockTypeImage BetaManagedAgentsImageBlockType = "image"` - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `Source BetaManagedAgentsDocumentBlockSourceUnion` Union type for document source variants. - `type BetaManagedAgentsBase64DocumentSource struct{…}` Base64-encoded document data. - `Data string` Base64-encoded document data. - `MediaType string` MIME type of the document (e.g., "application/pdf"). - `Type BetaManagedAgentsBase64DocumentSourceType` - `const BetaManagedAgentsBase64DocumentSourceTypeBase64 BetaManagedAgentsBase64DocumentSourceType = "base64"` - `type BetaManagedAgentsPlainTextDocumentSource struct{…}` Plain text document content. - `Data string` The plain text content. - `MediaType BetaManagedAgentsPlainTextDocumentSourceMediaType` MIME type of the text content. Must be "text/plain". - `const BetaManagedAgentsPlainTextDocumentSourceMediaTypeTextPlain BetaManagedAgentsPlainTextDocumentSourceMediaType = "text/plain"` - `Type BetaManagedAgentsPlainTextDocumentSourceType` - `const BetaManagedAgentsPlainTextDocumentSourceTypeText BetaManagedAgentsPlainTextDocumentSourceType = "text"` - `type BetaManagedAgentsURLDocumentSource struct{…}` Document referenced by URL. - `Type BetaManagedAgentsURLDocumentSourceType` - `const BetaManagedAgentsURLDocumentSourceTypeURL BetaManagedAgentsURLDocumentSourceType = "url"` - `URL string` URL of the document to fetch. - `type BetaManagedAgentsFileDocumentSource struct{…}` Document referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileDocumentSourceType` - `const BetaManagedAgentsFileDocumentSourceTypeFile BetaManagedAgentsFileDocumentSourceType = "file"` - `Type BetaManagedAgentsDocumentBlockType` - `const BetaManagedAgentsDocumentBlockTypeDocument BetaManagedAgentsDocumentBlockType = "document"` - `Context string` Additional context about the document for the model. - `Title string` The title of the document. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `Citations BetaManagedAgentsSearchResultCitations` Citation settings for a search result. - `Enabled bool` Whether citations are enabled for this search result. - `Content []BetaManagedAgentsSearchResultContent` Array of text content blocks from the search result. - `Text string` The text content. - `Type BetaManagedAgentsSearchResultContentType` - `const BetaManagedAgentsSearchResultContentTypeText BetaManagedAgentsSearchResultContentType = "text"` - `Source string` The URL source of the search result. - `Title string` The title of the search result. - `Type BetaManagedAgentsSearchResultBlockType` - `const BetaManagedAgentsSearchResultBlockTypeSearchResult BetaManagedAgentsSearchResultBlockType = "search_result"` - `IsError bool` Whether the tool execution resulted in an error. # Resources ## Add Session Resource `client.Beta.Sessions.Resources.Add(ctx, sessionID, params) (*BetaManagedAgentsFileResource, error)` **post** `/v1/sessions/{session_id}/resources` Add Session Resource ### Parameters - `sessionID string` - `params BetaSessionResourceAddParams` - `BetaManagedAgentsFileResourceParams param.Field[BetaManagedAgentsFileResourceParamsResp]` Body param: Mount a file uploaded via the Files API into the session. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsFileResource struct{…}` - `ID string` - `CreatedAt Time` A timestamp in RFC 3339 format - `FileID string` - `MountPath string` - `Type BetaManagedAgentsFileResourceType` - `const BetaManagedAgentsFileResourceTypeFile BetaManagedAgentsFileResourceType = "file"` - `UpdatedAt Time` A timestamp in RFC 3339 format ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsFileResource, err := client.Beta.Sessions.Resources.Add( context.TODO(), "sesn_011CZkZAtmR3yMPDzynEDxu7", anthropic.BetaSessionResourceAddParams{ BetaManagedAgentsFileResourceParams: anthropic.BetaManagedAgentsFileResourceParams{ FileID: "file_011CNha8iCJcU1wXNR6q4V8w", Type: anthropic.BetaManagedAgentsFileResourceParamsTypeFile, }, }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsFileResource.ID) } ``` #### Response ```json { "id": "sesrsc_011CZkZBJq5dWxk9fVLNcPht", "created_at": "2026-03-15T10:00:00Z", "file_id": "file_011CNha8iCJcU1wXNR6q4V8w", "mount_path": "/uploads/receipt.pdf", "type": "file", "updated_at": "2026-03-15T10:00:00Z" } ``` ## List Session Resources `client.Beta.Sessions.Resources.List(ctx, sessionID, params) (*PageCursor[BetaManagedAgentsSessionResourceUnion], error)` **get** `/v1/sessions/{session_id}/resources` List Session Resources ### Parameters - `sessionID string` - `params BetaSessionResourceListParams` - `Limit param.Field[int64]` Query param: Maximum number of resources to return per page (max 1000). If omitted, returns all resources. - `Page param.Field[string]` Query param: Opaque cursor from a previous response's next_page field. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsSessionResourceUnion interface{…}` A memory store attached to an agent session. - `type BetaManagedAgentsGitHubRepositoryResource struct{…}` - `ID string` - `CreatedAt Time` A timestamp in RFC 3339 format - `MountPath string` - `Type BetaManagedAgentsGitHubRepositoryResourceType` - `const BetaManagedAgentsGitHubRepositoryResourceTypeGitHubRepository BetaManagedAgentsGitHubRepositoryResourceType = "github_repository"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `URL string` - `Checkout BetaManagedAgentsGitHubRepositoryResourceCheckoutUnion` - `type BetaManagedAgentsBranchCheckout struct{…}` - `Name string` Branch name to check out. - `Type BetaManagedAgentsBranchCheckoutType` - `const BetaManagedAgentsBranchCheckoutTypeBranch BetaManagedAgentsBranchCheckoutType = "branch"` - `type BetaManagedAgentsCommitCheckout struct{…}` - `Sha string` Full commit SHA to check out. - `Type BetaManagedAgentsCommitCheckoutType` - `const BetaManagedAgentsCommitCheckoutTypeCommit BetaManagedAgentsCommitCheckoutType = "commit"` - `type BetaManagedAgentsFileResource struct{…}` - `ID string` - `CreatedAt Time` A timestamp in RFC 3339 format - `FileID string` - `MountPath string` - `Type BetaManagedAgentsFileResourceType` - `const BetaManagedAgentsFileResourceTypeFile BetaManagedAgentsFileResourceType = "file"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `type BetaManagedAgentsMemoryStoreResource struct{…}` A memory store attached to an agent session. - `MemoryStoreID string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `Type BetaManagedAgentsMemoryStoreResourceType` - `const BetaManagedAgentsMemoryStoreResourceTypeMemoryStore BetaManagedAgentsMemoryStoreResourceType = "memory_store"` - `Access BetaManagedAgentsMemoryStoreResourceAccess` Access mode for an attached memory store. - `const BetaManagedAgentsMemoryStoreResourceAccessReadWrite BetaManagedAgentsMemoryStoreResourceAccess = "read_write"` - `const BetaManagedAgentsMemoryStoreResourceAccessReadOnly BetaManagedAgentsMemoryStoreResourceAccess = "read_only"` - `Description string` Description of the memory store, snapshotted at attach time. Rendered into the agent's system prompt. Empty string when the store has no description. - `Instructions string` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `MountPath string` Filesystem path where the store is mounted in the session container, e.g. /mnt/memory/user-preferences. Derived from the store's name. Output-only. - `Name string` Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) page, err := client.Beta.Sessions.Resources.List( context.TODO(), "sesn_011CZkZAtmR3yMPDzynEDxu7", anthropic.BetaSessionResourceListParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "data": [ { "id": "sesrsc_011CZkZBJq5dWxk9fVLNcPht", "created_at": "2026-03-15T10:00:00Z", "file_id": "file_011CNha8iCJcU1wXNR6q4V8w", "mount_path": "/uploads/receipt.pdf", "type": "file", "updated_at": "2026-03-15T10:00:00Z" }, { "id": "sesrsc_011CZkZCKr6eXyl0gWMOdQiu", "created_at": "2026-03-15T10:00:00Z", "mount_path": "/workspace/example-repo", "type": "github_repository", "updated_at": "2026-03-15T10:00:00Z", "url": "https://github.com/example-org/example-repo", "checkout": { "name": "main", "type": "branch" } } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ## Get Session Resource `client.Beta.Sessions.Resources.Get(ctx, resourceID, params) (*BetaSessionResourceGetResponseUnion, error)` **get** `/v1/sessions/{session_id}/resources/{resource_id}` Get Session Resource ### Parameters - `resourceID string` - `params BetaSessionResourceGetParams` - `SessionID param.Field[string]` Path param: Path parameter session_id - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaSessionResourceGetResponseUnion interface{…}` The requested session resource. - `type BetaManagedAgentsGitHubRepositoryResource struct{…}` - `ID string` - `CreatedAt Time` A timestamp in RFC 3339 format - `MountPath string` - `Type BetaManagedAgentsGitHubRepositoryResourceType` - `const BetaManagedAgentsGitHubRepositoryResourceTypeGitHubRepository BetaManagedAgentsGitHubRepositoryResourceType = "github_repository"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `URL string` - `Checkout BetaManagedAgentsGitHubRepositoryResourceCheckoutUnion` - `type BetaManagedAgentsBranchCheckout struct{…}` - `Name string` Branch name to check out. - `Type BetaManagedAgentsBranchCheckoutType` - `const BetaManagedAgentsBranchCheckoutTypeBranch BetaManagedAgentsBranchCheckoutType = "branch"` - `type BetaManagedAgentsCommitCheckout struct{…}` - `Sha string` Full commit SHA to check out. - `Type BetaManagedAgentsCommitCheckoutType` - `const BetaManagedAgentsCommitCheckoutTypeCommit BetaManagedAgentsCommitCheckoutType = "commit"` - `type BetaManagedAgentsFileResource struct{…}` - `ID string` - `CreatedAt Time` A timestamp in RFC 3339 format - `FileID string` - `MountPath string` - `Type BetaManagedAgentsFileResourceType` - `const BetaManagedAgentsFileResourceTypeFile BetaManagedAgentsFileResourceType = "file"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `type BetaManagedAgentsMemoryStoreResource struct{…}` A memory store attached to an agent session. - `MemoryStoreID string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `Type BetaManagedAgentsMemoryStoreResourceType` - `const BetaManagedAgentsMemoryStoreResourceTypeMemoryStore BetaManagedAgentsMemoryStoreResourceType = "memory_store"` - `Access BetaManagedAgentsMemoryStoreResourceAccess` Access mode for an attached memory store. - `const BetaManagedAgentsMemoryStoreResourceAccessReadWrite BetaManagedAgentsMemoryStoreResourceAccess = "read_write"` - `const BetaManagedAgentsMemoryStoreResourceAccessReadOnly BetaManagedAgentsMemoryStoreResourceAccess = "read_only"` - `Description string` Description of the memory store, snapshotted at attach time. Rendered into the agent's system prompt. Empty string when the store has no description. - `Instructions string` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `MountPath string` Filesystem path where the store is mounted in the session container, e.g. /mnt/memory/user-preferences. Derived from the store's name. Output-only. - `Name string` Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) resource, err := client.Beta.Sessions.Resources.Get( context.TODO(), "sesrsc_011CZkZBJq5dWxk9fVLNcPht", anthropic.BetaSessionResourceGetParams{ SessionID: "sesn_011CZkZAtmR3yMPDzynEDxu7", }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", resource) } ``` #### Response ```json { "id": "sesrsc_011CZkZCKr6eXyl0gWMOdQiu", "created_at": "2026-03-15T10:00:00Z", "mount_path": "/workspace/example-repo", "type": "github_repository", "updated_at": "2026-03-15T10:00:00Z", "url": "https://github.com/example-org/example-repo", "checkout": { "name": "main", "type": "branch" } } ``` ## Update Session Resource `client.Beta.Sessions.Resources.Update(ctx, resourceID, params) (*BetaSessionResourceUpdateResponseUnion, error)` **post** `/v1/sessions/{session_id}/resources/{resource_id}` Update Session Resource ### Parameters - `resourceID string` - `params BetaSessionResourceUpdateParams` - `SessionID param.Field[string]` Path param: Path parameter session_id - `AuthorizationToken param.Field[string]` Body param: New authorization token for the resource. Currently only `github_repository` resources support token rotation. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaSessionResourceUpdateResponseUnion interface{…}` The updated session resource. - `type BetaManagedAgentsGitHubRepositoryResource struct{…}` - `ID string` - `CreatedAt Time` A timestamp in RFC 3339 format - `MountPath string` - `Type BetaManagedAgentsGitHubRepositoryResourceType` - `const BetaManagedAgentsGitHubRepositoryResourceTypeGitHubRepository BetaManagedAgentsGitHubRepositoryResourceType = "github_repository"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `URL string` - `Checkout BetaManagedAgentsGitHubRepositoryResourceCheckoutUnion` - `type BetaManagedAgentsBranchCheckout struct{…}` - `Name string` Branch name to check out. - `Type BetaManagedAgentsBranchCheckoutType` - `const BetaManagedAgentsBranchCheckoutTypeBranch BetaManagedAgentsBranchCheckoutType = "branch"` - `type BetaManagedAgentsCommitCheckout struct{…}` - `Sha string` Full commit SHA to check out. - `Type BetaManagedAgentsCommitCheckoutType` - `const BetaManagedAgentsCommitCheckoutTypeCommit BetaManagedAgentsCommitCheckoutType = "commit"` - `type BetaManagedAgentsFileResource struct{…}` - `ID string` - `CreatedAt Time` A timestamp in RFC 3339 format - `FileID string` - `MountPath string` - `Type BetaManagedAgentsFileResourceType` - `const BetaManagedAgentsFileResourceTypeFile BetaManagedAgentsFileResourceType = "file"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `type BetaManagedAgentsMemoryStoreResource struct{…}` A memory store attached to an agent session. - `MemoryStoreID string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `Type BetaManagedAgentsMemoryStoreResourceType` - `const BetaManagedAgentsMemoryStoreResourceTypeMemoryStore BetaManagedAgentsMemoryStoreResourceType = "memory_store"` - `Access BetaManagedAgentsMemoryStoreResourceAccess` Access mode for an attached memory store. - `const BetaManagedAgentsMemoryStoreResourceAccessReadWrite BetaManagedAgentsMemoryStoreResourceAccess = "read_write"` - `const BetaManagedAgentsMemoryStoreResourceAccessReadOnly BetaManagedAgentsMemoryStoreResourceAccess = "read_only"` - `Description string` Description of the memory store, snapshotted at attach time. Rendered into the agent's system prompt. Empty string when the store has no description. - `Instructions string` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `MountPath string` Filesystem path where the store is mounted in the session container, e.g. /mnt/memory/user-preferences. Derived from the store's name. Output-only. - `Name string` Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) resource, err := client.Beta.Sessions.Resources.Update( context.TODO(), "sesrsc_011CZkZBJq5dWxk9fVLNcPht", anthropic.BetaSessionResourceUpdateParams{ SessionID: "sesn_011CZkZAtmR3yMPDzynEDxu7", AuthorizationToken: "ghp_exampletoken", }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", resource) } ``` #### Response ```json { "id": "sesrsc_011CZkZCKr6eXyl0gWMOdQiu", "created_at": "2026-03-15T10:00:00Z", "mount_path": "/workspace/example-repo", "type": "github_repository", "updated_at": "2026-03-15T10:00:00Z", "url": "https://github.com/example-org/example-repo", "checkout": { "name": "main", "type": "branch" } } ``` ## Delete Session Resource `client.Beta.Sessions.Resources.Delete(ctx, resourceID, params) (*BetaManagedAgentsDeleteSessionResource, error)` **delete** `/v1/sessions/{session_id}/resources/{resource_id}` Delete Session Resource ### Parameters - `resourceID string` - `params BetaSessionResourceDeleteParams` - `SessionID param.Field[string]` Path param: Path parameter session_id - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsDeleteSessionResource struct{…}` Confirmation of resource deletion. - `ID string` - `Type BetaManagedAgentsDeleteSessionResourceType` - `const BetaManagedAgentsDeleteSessionResourceTypeSessionResourceDeleted BetaManagedAgentsDeleteSessionResourceType = "session_resource_deleted"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsDeleteSessionResource, err := client.Beta.Sessions.Resources.Delete( context.TODO(), "sesrsc_011CZkZBJq5dWxk9fVLNcPht", anthropic.BetaSessionResourceDeleteParams{ SessionID: "sesn_011CZkZAtmR3yMPDzynEDxu7", }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsDeleteSessionResource.ID) } ``` #### Response ```json { "id": "sesrsc_011CZkZBJq5dWxk9fVLNcPht", "type": "session_resource_deleted" } ``` ## Domain Types ### Beta Managed Agents Delete Session Resource - `type BetaManagedAgentsDeleteSessionResource struct{…}` Confirmation of resource deletion. - `ID string` - `Type BetaManagedAgentsDeleteSessionResourceType` - `const BetaManagedAgentsDeleteSessionResourceTypeSessionResourceDeleted BetaManagedAgentsDeleteSessionResourceType = "session_resource_deleted"` ### Beta Managed Agents File Resource - `type BetaManagedAgentsFileResource struct{…}` - `ID string` - `CreatedAt Time` A timestamp in RFC 3339 format - `FileID string` - `MountPath string` - `Type BetaManagedAgentsFileResourceType` - `const BetaManagedAgentsFileResourceTypeFile BetaManagedAgentsFileResourceType = "file"` - `UpdatedAt Time` A timestamp in RFC 3339 format ### Beta Managed Agents GitHub Repository Resource - `type BetaManagedAgentsGitHubRepositoryResource struct{…}` - `ID string` - `CreatedAt Time` A timestamp in RFC 3339 format - `MountPath string` - `Type BetaManagedAgentsGitHubRepositoryResourceType` - `const BetaManagedAgentsGitHubRepositoryResourceTypeGitHubRepository BetaManagedAgentsGitHubRepositoryResourceType = "github_repository"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `URL string` - `Checkout BetaManagedAgentsGitHubRepositoryResourceCheckoutUnion` - `type BetaManagedAgentsBranchCheckout struct{…}` - `Name string` Branch name to check out. - `Type BetaManagedAgentsBranchCheckoutType` - `const BetaManagedAgentsBranchCheckoutTypeBranch BetaManagedAgentsBranchCheckoutType = "branch"` - `type BetaManagedAgentsCommitCheckout struct{…}` - `Sha string` Full commit SHA to check out. - `Type BetaManagedAgentsCommitCheckoutType` - `const BetaManagedAgentsCommitCheckoutTypeCommit BetaManagedAgentsCommitCheckoutType = "commit"` ### Beta Managed Agents Memory Store Resource - `type BetaManagedAgentsMemoryStoreResource struct{…}` A memory store attached to an agent session. - `MemoryStoreID string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `Type BetaManagedAgentsMemoryStoreResourceType` - `const BetaManagedAgentsMemoryStoreResourceTypeMemoryStore BetaManagedAgentsMemoryStoreResourceType = "memory_store"` - `Access BetaManagedAgentsMemoryStoreResourceAccess` Access mode for an attached memory store. - `const BetaManagedAgentsMemoryStoreResourceAccessReadWrite BetaManagedAgentsMemoryStoreResourceAccess = "read_write"` - `const BetaManagedAgentsMemoryStoreResourceAccessReadOnly BetaManagedAgentsMemoryStoreResourceAccess = "read_only"` - `Description string` Description of the memory store, snapshotted at attach time. Rendered into the agent's system prompt. Empty string when the store has no description. - `Instructions string` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `MountPath string` Filesystem path where the store is mounted in the session container, e.g. /mnt/memory/user-preferences. Derived from the store's name. Output-only. - `Name string` Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. ### Beta Managed Agents Session Resource - `type BetaManagedAgentsSessionResourceUnion interface{…}` A memory store attached to an agent session. - `type BetaManagedAgentsGitHubRepositoryResource struct{…}` - `ID string` - `CreatedAt Time` A timestamp in RFC 3339 format - `MountPath string` - `Type BetaManagedAgentsGitHubRepositoryResourceType` - `const BetaManagedAgentsGitHubRepositoryResourceTypeGitHubRepository BetaManagedAgentsGitHubRepositoryResourceType = "github_repository"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `URL string` - `Checkout BetaManagedAgentsGitHubRepositoryResourceCheckoutUnion` - `type BetaManagedAgentsBranchCheckout struct{…}` - `Name string` Branch name to check out. - `Type BetaManagedAgentsBranchCheckoutType` - `const BetaManagedAgentsBranchCheckoutTypeBranch BetaManagedAgentsBranchCheckoutType = "branch"` - `type BetaManagedAgentsCommitCheckout struct{…}` - `Sha string` Full commit SHA to check out. - `Type BetaManagedAgentsCommitCheckoutType` - `const BetaManagedAgentsCommitCheckoutTypeCommit BetaManagedAgentsCommitCheckoutType = "commit"` - `type BetaManagedAgentsFileResource struct{…}` - `ID string` - `CreatedAt Time` A timestamp in RFC 3339 format - `FileID string` - `MountPath string` - `Type BetaManagedAgentsFileResourceType` - `const BetaManagedAgentsFileResourceTypeFile BetaManagedAgentsFileResourceType = "file"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `type BetaManagedAgentsMemoryStoreResource struct{…}` A memory store attached to an agent session. - `MemoryStoreID string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `Type BetaManagedAgentsMemoryStoreResourceType` - `const BetaManagedAgentsMemoryStoreResourceTypeMemoryStore BetaManagedAgentsMemoryStoreResourceType = "memory_store"` - `Access BetaManagedAgentsMemoryStoreResourceAccess` Access mode for an attached memory store. - `const BetaManagedAgentsMemoryStoreResourceAccessReadWrite BetaManagedAgentsMemoryStoreResourceAccess = "read_write"` - `const BetaManagedAgentsMemoryStoreResourceAccessReadOnly BetaManagedAgentsMemoryStoreResourceAccess = "read_only"` - `Description string` Description of the memory store, snapshotted at attach time. Rendered into the agent's system prompt. Empty string when the store has no description. - `Instructions string` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `MountPath string` Filesystem path where the store is mounted in the session container, e.g. /mnt/memory/user-preferences. Derived from the store's name. Output-only. - `Name string` Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. # Threads ## List Session Threads `client.Beta.Sessions.Threads.List(ctx, sessionID, params) (*PageCursor[BetaManagedAgentsSessionThread], error)` **get** `/v1/sessions/{session_id}/threads` List Session Threads ### Parameters - `sessionID string` - `params BetaSessionThreadListParams` - `Limit param.Field[int64]` Query param: Maximum results per page. Defaults to 1000. - `Page param.Field[string]` Query param: Opaque pagination cursor from a previous response's next_page. Forward-only. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsSessionThread struct{…}` An execution thread within a `session`. Each session has one primary thread plus zero or more child threads spawned by the coordinator. - `ID string` Unique identifier for this thread. - `Agent BetaManagedAgentsSessionThreadAgent` Resolved `agent` definition for a single `session_thread`. Snapshot of the agent at thread creation time. The multiagent roster is not repeated here; read it from `Session.agent`. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Name string` - `Skills []BetaManagedAgentsSessionThreadAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsSessionThreadAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsSessionThreadAgentType` - `const BetaManagedAgentsSessionThreadAgentTypeAgent BetaManagedAgentsSessionThreadAgentType = "agent"` - `Version int64` - `ArchivedAt Time` A timestamp in RFC 3339 format - `CreatedAt Time` A timestamp in RFC 3339 format - `ParentThreadID string` Parent thread that spawned this thread. Null for the primary thread. - `SessionID string` The session this thread belongs to. - `Stats BetaManagedAgentsSessionThreadStats` Timing statistics for a session thread. - `ActiveSeconds float64` Cumulative time in seconds the thread spent actively running. Excludes idle time. - `DurationSeconds float64` Elapsed time since thread creation in seconds. For archived threads, frozen at the final update. - `StartupSeconds float64` Time in seconds for the thread to begin running. Zero for child threads, which start immediately. - `Status BetaManagedAgentsSessionThreadStatus` SessionThreadStatus enum - `const BetaManagedAgentsSessionThreadStatusRunning BetaManagedAgentsSessionThreadStatus = "running"` - `const BetaManagedAgentsSessionThreadStatusIdle BetaManagedAgentsSessionThreadStatus = "idle"` - `const BetaManagedAgentsSessionThreadStatusRescheduling BetaManagedAgentsSessionThreadStatus = "rescheduling"` - `const BetaManagedAgentsSessionThreadStatusTerminated BetaManagedAgentsSessionThreadStatus = "terminated"` - `Type BetaManagedAgentsSessionThreadType` - `const BetaManagedAgentsSessionThreadTypeSessionThread BetaManagedAgentsSessionThreadType = "session_thread"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `Usage BetaManagedAgentsSessionThreadUsage` Cumulative token usage for a session thread across all turns. - `CacheCreation BetaManagedAgentsCacheCreationUsage` Prompt-cache creation token usage broken down by cache lifetime. - `Ephemeral1hInputTokens int64` Tokens used to create 1-hour ephemeral cache entries. - `Ephemeral5mInputTokens int64` Tokens used to create 5-minute ephemeral cache entries. - `CacheReadInputTokens int64` Total tokens read from prompt cache. - `InputTokens int64` Total input tokens consumed across all turns. - `OutputTokens int64` Total output tokens generated across all turns. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) page, err := client.Beta.Sessions.Threads.List( context.TODO(), "sesn_011CZkZAtmR3yMPDzynEDxu7", anthropic.BetaSessionThreadListParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "data": [ { "id": "sthr_011CZkZVWa6oIjw0rgXZpnBt", "agent": { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "name": "Researcher", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" } ], "system": "You are a research subagent that gathers and summarises sources for the coordinating agent.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "parent_thread_id": null, "session_id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "stats": { "active_seconds": 0, "duration_seconds": 0, "startup_seconds": 0 }, "status": "idle", "type": "session_thread", "updated_at": "2026-03-15T10:00:00Z", "usage": { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0 } } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ## Get Session Thread `client.Beta.Sessions.Threads.Get(ctx, threadID, params) (*BetaManagedAgentsSessionThread, error)` **get** `/v1/sessions/{session_id}/threads/{thread_id}` Get Session Thread ### Parameters - `threadID string` - `params BetaSessionThreadGetParams` - `SessionID param.Field[string]` Path param: Path parameter session_id - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsSessionThread struct{…}` An execution thread within a `session`. Each session has one primary thread plus zero or more child threads spawned by the coordinator. - `ID string` Unique identifier for this thread. - `Agent BetaManagedAgentsSessionThreadAgent` Resolved `agent` definition for a single `session_thread`. Snapshot of the agent at thread creation time. The multiagent roster is not repeated here; read it from `Session.agent`. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Name string` - `Skills []BetaManagedAgentsSessionThreadAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsSessionThreadAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsSessionThreadAgentType` - `const BetaManagedAgentsSessionThreadAgentTypeAgent BetaManagedAgentsSessionThreadAgentType = "agent"` - `Version int64` - `ArchivedAt Time` A timestamp in RFC 3339 format - `CreatedAt Time` A timestamp in RFC 3339 format - `ParentThreadID string` Parent thread that spawned this thread. Null for the primary thread. - `SessionID string` The session this thread belongs to. - `Stats BetaManagedAgentsSessionThreadStats` Timing statistics for a session thread. - `ActiveSeconds float64` Cumulative time in seconds the thread spent actively running. Excludes idle time. - `DurationSeconds float64` Elapsed time since thread creation in seconds. For archived threads, frozen at the final update. - `StartupSeconds float64` Time in seconds for the thread to begin running. Zero for child threads, which start immediately. - `Status BetaManagedAgentsSessionThreadStatus` SessionThreadStatus enum - `const BetaManagedAgentsSessionThreadStatusRunning BetaManagedAgentsSessionThreadStatus = "running"` - `const BetaManagedAgentsSessionThreadStatusIdle BetaManagedAgentsSessionThreadStatus = "idle"` - `const BetaManagedAgentsSessionThreadStatusRescheduling BetaManagedAgentsSessionThreadStatus = "rescheduling"` - `const BetaManagedAgentsSessionThreadStatusTerminated BetaManagedAgentsSessionThreadStatus = "terminated"` - `Type BetaManagedAgentsSessionThreadType` - `const BetaManagedAgentsSessionThreadTypeSessionThread BetaManagedAgentsSessionThreadType = "session_thread"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `Usage BetaManagedAgentsSessionThreadUsage` Cumulative token usage for a session thread across all turns. - `CacheCreation BetaManagedAgentsCacheCreationUsage` Prompt-cache creation token usage broken down by cache lifetime. - `Ephemeral1hInputTokens int64` Tokens used to create 1-hour ephemeral cache entries. - `Ephemeral5mInputTokens int64` Tokens used to create 5-minute ephemeral cache entries. - `CacheReadInputTokens int64` Total tokens read from prompt cache. - `InputTokens int64` Total input tokens consumed across all turns. - `OutputTokens int64` Total output tokens generated across all turns. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsSessionThread, err := client.Beta.Sessions.Threads.Get( context.TODO(), "sthr_011CZkZVWa6oIjw0rgXZpnBt", anthropic.BetaSessionThreadGetParams{ SessionID: "sesn_011CZkZAtmR3yMPDzynEDxu7", }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsSessionThread.ID) } ``` #### Response ```json { "id": "sthr_011CZkZVWa6oIjw0rgXZpnBt", "agent": { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "name": "Researcher", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" } ], "system": "You are a research subagent that gathers and summarises sources for the coordinating agent.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "parent_thread_id": null, "session_id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "stats": { "active_seconds": 0, "duration_seconds": 0, "startup_seconds": 0 }, "status": "idle", "type": "session_thread", "updated_at": "2026-03-15T10:00:00Z", "usage": { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0 } } ``` ## Archive Session Thread `client.Beta.Sessions.Threads.Archive(ctx, threadID, params) (*BetaManagedAgentsSessionThread, error)` **post** `/v1/sessions/{session_id}/threads/{thread_id}/archive` Archive Session Thread ### Parameters - `threadID string` - `params BetaSessionThreadArchiveParams` - `SessionID param.Field[string]` Path param: Path parameter session_id - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsSessionThread struct{…}` An execution thread within a `session`. Each session has one primary thread plus zero or more child threads spawned by the coordinator. - `ID string` Unique identifier for this thread. - `Agent BetaManagedAgentsSessionThreadAgent` Resolved `agent` definition for a single `session_thread`. Snapshot of the agent at thread creation time. The multiagent roster is not repeated here; read it from `Session.agent`. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Name string` - `Skills []BetaManagedAgentsSessionThreadAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsSessionThreadAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsSessionThreadAgentType` - `const BetaManagedAgentsSessionThreadAgentTypeAgent BetaManagedAgentsSessionThreadAgentType = "agent"` - `Version int64` - `ArchivedAt Time` A timestamp in RFC 3339 format - `CreatedAt Time` A timestamp in RFC 3339 format - `ParentThreadID string` Parent thread that spawned this thread. Null for the primary thread. - `SessionID string` The session this thread belongs to. - `Stats BetaManagedAgentsSessionThreadStats` Timing statistics for a session thread. - `ActiveSeconds float64` Cumulative time in seconds the thread spent actively running. Excludes idle time. - `DurationSeconds float64` Elapsed time since thread creation in seconds. For archived threads, frozen at the final update. - `StartupSeconds float64` Time in seconds for the thread to begin running. Zero for child threads, which start immediately. - `Status BetaManagedAgentsSessionThreadStatus` SessionThreadStatus enum - `const BetaManagedAgentsSessionThreadStatusRunning BetaManagedAgentsSessionThreadStatus = "running"` - `const BetaManagedAgentsSessionThreadStatusIdle BetaManagedAgentsSessionThreadStatus = "idle"` - `const BetaManagedAgentsSessionThreadStatusRescheduling BetaManagedAgentsSessionThreadStatus = "rescheduling"` - `const BetaManagedAgentsSessionThreadStatusTerminated BetaManagedAgentsSessionThreadStatus = "terminated"` - `Type BetaManagedAgentsSessionThreadType` - `const BetaManagedAgentsSessionThreadTypeSessionThread BetaManagedAgentsSessionThreadType = "session_thread"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `Usage BetaManagedAgentsSessionThreadUsage` Cumulative token usage for a session thread across all turns. - `CacheCreation BetaManagedAgentsCacheCreationUsage` Prompt-cache creation token usage broken down by cache lifetime. - `Ephemeral1hInputTokens int64` Tokens used to create 1-hour ephemeral cache entries. - `Ephemeral5mInputTokens int64` Tokens used to create 5-minute ephemeral cache entries. - `CacheReadInputTokens int64` Total tokens read from prompt cache. - `InputTokens int64` Total input tokens consumed across all turns. - `OutputTokens int64` Total output tokens generated across all turns. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsSessionThread, err := client.Beta.Sessions.Threads.Archive( context.TODO(), "sthr_011CZkZVWa6oIjw0rgXZpnBt", anthropic.BetaSessionThreadArchiveParams{ SessionID: "sesn_011CZkZAtmR3yMPDzynEDxu7", }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsSessionThread.ID) } ``` #### Response ```json { "id": "sthr_011CZkZVWa6oIjw0rgXZpnBt", "agent": { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "name": "Researcher", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" } ], "system": "You are a research subagent that gathers and summarises sources for the coordinating agent.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "parent_thread_id": null, "session_id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "stats": { "active_seconds": 0, "duration_seconds": 0, "startup_seconds": 0 }, "status": "idle", "type": "session_thread", "updated_at": "2026-03-15T10:00:00Z", "usage": { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0 } } ``` ## Domain Types ### Beta Managed Agents Session Thread - `type BetaManagedAgentsSessionThread struct{…}` An execution thread within a `session`. Each session has one primary thread plus zero or more child threads spawned by the coordinator. - `ID string` Unique identifier for this thread. - `Agent BetaManagedAgentsSessionThreadAgent` Resolved `agent` definition for a single `session_thread`. Snapshot of the agent at thread creation time. The multiagent roster is not repeated here; read it from `Session.agent`. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Name string` - `Skills []BetaManagedAgentsSessionThreadAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsSessionThreadAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsSessionThreadAgentType` - `const BetaManagedAgentsSessionThreadAgentTypeAgent BetaManagedAgentsSessionThreadAgentType = "agent"` - `Version int64` - `ArchivedAt Time` A timestamp in RFC 3339 format - `CreatedAt Time` A timestamp in RFC 3339 format - `ParentThreadID string` Parent thread that spawned this thread. Null for the primary thread. - `SessionID string` The session this thread belongs to. - `Stats BetaManagedAgentsSessionThreadStats` Timing statistics for a session thread. - `ActiveSeconds float64` Cumulative time in seconds the thread spent actively running. Excludes idle time. - `DurationSeconds float64` Elapsed time since thread creation in seconds. For archived threads, frozen at the final update. - `StartupSeconds float64` Time in seconds for the thread to begin running. Zero for child threads, which start immediately. - `Status BetaManagedAgentsSessionThreadStatus` SessionThreadStatus enum - `const BetaManagedAgentsSessionThreadStatusRunning BetaManagedAgentsSessionThreadStatus = "running"` - `const BetaManagedAgentsSessionThreadStatusIdle BetaManagedAgentsSessionThreadStatus = "idle"` - `const BetaManagedAgentsSessionThreadStatusRescheduling BetaManagedAgentsSessionThreadStatus = "rescheduling"` - `const BetaManagedAgentsSessionThreadStatusTerminated BetaManagedAgentsSessionThreadStatus = "terminated"` - `Type BetaManagedAgentsSessionThreadType` - `const BetaManagedAgentsSessionThreadTypeSessionThread BetaManagedAgentsSessionThreadType = "session_thread"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `Usage BetaManagedAgentsSessionThreadUsage` Cumulative token usage for a session thread across all turns. - `CacheCreation BetaManagedAgentsCacheCreationUsage` Prompt-cache creation token usage broken down by cache lifetime. - `Ephemeral1hInputTokens int64` Tokens used to create 1-hour ephemeral cache entries. - `Ephemeral5mInputTokens int64` Tokens used to create 5-minute ephemeral cache entries. - `CacheReadInputTokens int64` Total tokens read from prompt cache. - `InputTokens int64` Total input tokens consumed across all turns. - `OutputTokens int64` Total output tokens generated across all turns. ### Beta Managed Agents Session Thread Stats - `type BetaManagedAgentsSessionThreadStats struct{…}` Timing statistics for a session thread. - `ActiveSeconds float64` Cumulative time in seconds the thread spent actively running. Excludes idle time. - `DurationSeconds float64` Elapsed time since thread creation in seconds. For archived threads, frozen at the final update. - `StartupSeconds float64` Time in seconds for the thread to begin running. Zero for child threads, which start immediately. ### Beta Managed Agents Session Thread Status - `type BetaManagedAgentsSessionThreadStatus string` SessionThreadStatus enum - `const BetaManagedAgentsSessionThreadStatusRunning BetaManagedAgentsSessionThreadStatus = "running"` - `const BetaManagedAgentsSessionThreadStatusIdle BetaManagedAgentsSessionThreadStatus = "idle"` - `const BetaManagedAgentsSessionThreadStatusRescheduling BetaManagedAgentsSessionThreadStatus = "rescheduling"` - `const BetaManagedAgentsSessionThreadStatusTerminated BetaManagedAgentsSessionThreadStatus = "terminated"` ### Beta Managed Agents Session Thread Usage - `type BetaManagedAgentsSessionThreadUsage struct{…}` Cumulative token usage for a session thread across all turns. - `CacheCreation BetaManagedAgentsCacheCreationUsage` Prompt-cache creation token usage broken down by cache lifetime. - `Ephemeral1hInputTokens int64` Tokens used to create 1-hour ephemeral cache entries. - `Ephemeral5mInputTokens int64` Tokens used to create 5-minute ephemeral cache entries. - `CacheReadInputTokens int64` Total tokens read from prompt cache. - `InputTokens int64` Total input tokens consumed across all turns. - `OutputTokens int64` Total output tokens generated across all turns. ### Beta Managed Agents Stream Session Thread Events - `type BetaManagedAgentsStreamSessionThreadEventsUnion interface{…}` Server-sent event in a single thread's stream. - `type BetaManagedAgentsUserMessageEvent struct{…}` A user message event in the session conversation. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsUserMessageEventContentUnion` Array of content blocks comprising the user message. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `const BetaManagedAgentsTextBlockTypeText BetaManagedAgentsTextBlockType = "text"` - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `Source BetaManagedAgentsImageBlockSourceUnion` Union type for image source variants. - `type BetaManagedAgentsBase64ImageSource struct{…}` Base64-encoded image data. - `Data string` Base64-encoded image data. - `MediaType string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `Type BetaManagedAgentsBase64ImageSourceType` - `const BetaManagedAgentsBase64ImageSourceTypeBase64 BetaManagedAgentsBase64ImageSourceType = "base64"` - `type BetaManagedAgentsURLImageSource struct{…}` Image referenced by URL. - `Type BetaManagedAgentsURLImageSourceType` - `const BetaManagedAgentsURLImageSourceTypeURL BetaManagedAgentsURLImageSourceType = "url"` - `URL string` URL of the image to fetch. - `type BetaManagedAgentsFileImageSource struct{…}` Image referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileImageSourceType` - `const BetaManagedAgentsFileImageSourceTypeFile BetaManagedAgentsFileImageSourceType = "file"` - `Type BetaManagedAgentsImageBlockType` - `const BetaManagedAgentsImageBlockTypeImage BetaManagedAgentsImageBlockType = "image"` - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `Source BetaManagedAgentsDocumentBlockSourceUnion` Union type for document source variants. - `type BetaManagedAgentsBase64DocumentSource struct{…}` Base64-encoded document data. - `Data string` Base64-encoded document data. - `MediaType string` MIME type of the document (e.g., "application/pdf"). - `Type BetaManagedAgentsBase64DocumentSourceType` - `const BetaManagedAgentsBase64DocumentSourceTypeBase64 BetaManagedAgentsBase64DocumentSourceType = "base64"` - `type BetaManagedAgentsPlainTextDocumentSource struct{…}` Plain text document content. - `Data string` The plain text content. - `MediaType BetaManagedAgentsPlainTextDocumentSourceMediaType` MIME type of the text content. Must be "text/plain". - `const BetaManagedAgentsPlainTextDocumentSourceMediaTypeTextPlain BetaManagedAgentsPlainTextDocumentSourceMediaType = "text/plain"` - `Type BetaManagedAgentsPlainTextDocumentSourceType` - `const BetaManagedAgentsPlainTextDocumentSourceTypeText BetaManagedAgentsPlainTextDocumentSourceType = "text"` - `type BetaManagedAgentsURLDocumentSource struct{…}` Document referenced by URL. - `Type BetaManagedAgentsURLDocumentSourceType` - `const BetaManagedAgentsURLDocumentSourceTypeURL BetaManagedAgentsURLDocumentSourceType = "url"` - `URL string` URL of the document to fetch. - `type BetaManagedAgentsFileDocumentSource struct{…}` Document referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileDocumentSourceType` - `const BetaManagedAgentsFileDocumentSourceTypeFile BetaManagedAgentsFileDocumentSourceType = "file"` - `Type BetaManagedAgentsDocumentBlockType` - `const BetaManagedAgentsDocumentBlockTypeDocument BetaManagedAgentsDocumentBlockType = "document"` - `Context string` Additional context about the document for the model. - `Title string` The title of the document. - `Type BetaManagedAgentsUserMessageEventType` - `const BetaManagedAgentsUserMessageEventTypeUserMessage BetaManagedAgentsUserMessageEventType = "user.message"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `type BetaManagedAgentsUserInterruptEvent struct{…}` An interrupt event that pauses agent execution and returns control to the user. - `ID string` Unique identifier for this event. - `Type BetaManagedAgentsUserInterruptEventType` - `const BetaManagedAgentsUserInterruptEventTypeUserInterrupt BetaManagedAgentsUserInterruptEventType = "user.interrupt"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. - `type BetaManagedAgentsUserToolConfirmationEvent struct{…}` A tool confirmation event that approves or denies a pending tool execution. - `ID string` Unique identifier for this event. - `Result BetaManagedAgentsUserToolConfirmationEventResult` UserToolConfirmationResult enum - `const BetaManagedAgentsUserToolConfirmationEventResultAllow BetaManagedAgentsUserToolConfirmationEventResult = "allow"` - `const BetaManagedAgentsUserToolConfirmationEventResultDeny BetaManagedAgentsUserToolConfirmationEventResult = "deny"` - `ToolUseID string` The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserToolConfirmationEventType` - `const BetaManagedAgentsUserToolConfirmationEventTypeUserToolConfirmation BetaManagedAgentsUserToolConfirmationEventType = "user.tool_confirmation"` - `DenyMessage string` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` When set, the confirmation routes to this subagent's thread rather than the primary. Echo this from the `session_thread_id` on the `agent.tool_use` or `agent.mcp_tool_use` event that prompted the approval. - `type BetaManagedAgentsUserCustomToolResultEvent struct{…}` Event sent by the client providing the result of a custom tool execution. - `ID string` Unique identifier for this event. - `CustomToolUseID string` The id of the `agent.custom_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserCustomToolResultEventType` - `const BetaManagedAgentsUserCustomToolResultEventTypeUserCustomToolResult BetaManagedAgentsUserCustomToolResultEventType = "user.custom_tool_result"` - `Content []BetaManagedAgentsUserCustomToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `Citations BetaManagedAgentsSearchResultCitations` Citation settings for a search result. - `Enabled bool` Whether citations are enabled for this search result. - `Content []BetaManagedAgentsSearchResultContent` Array of text content blocks from the search result. - `Text string` The text content. - `Type BetaManagedAgentsSearchResultContentType` - `const BetaManagedAgentsSearchResultContentTypeText BetaManagedAgentsSearchResultContentType = "text"` - `Source string` The URL source of the search result. - `Title string` The title of the search result. - `Type BetaManagedAgentsSearchResultBlockType` - `const BetaManagedAgentsSearchResultBlockTypeSearchResult BetaManagedAgentsSearchResultBlockType = "search_result"` - `IsError bool` Whether the tool execution resulted in an error. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Routes this result to a subagent thread. Copy from the `agent.custom_tool_use` event's `session_thread_id`. - `type BetaManagedAgentsAgentCustomToolUseEvent struct{…}` Event emitted when the agent calls a custom tool. The session goes idle until the client sends a `user.custom_tool_result` event with the result. - `ID string` Unique identifier for this event. - `Input map[string, any]` Input parameters for the tool call. - `Name string` Name of the custom tool being called. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentCustomToolUseEventType` - `const BetaManagedAgentsAgentCustomToolUseEventTypeAgentCustomToolUse BetaManagedAgentsAgentCustomToolUseEventType = "agent.custom_tool_use"` - `SessionThreadID string` When set, this event was cross-posted from a subagent's thread to surface its custom tool use on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.custom_tool_result` event to route the result back. - `type BetaManagedAgentsAgentMessageEvent struct{…}` An agent response event in the session conversation. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsTextBlock` Array of text blocks comprising the agent response. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentMessageEventType` - `const BetaManagedAgentsAgentMessageEventTypeAgentMessage BetaManagedAgentsAgentMessageEventType = "agent.message"` - `type BetaManagedAgentsAgentThinkingEvent struct{…}` Indicates the agent is making forward progress via extended thinking. A progress signal, not a content carrier. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentThinkingEventType` - `const BetaManagedAgentsAgentThinkingEventTypeAgentThinking BetaManagedAgentsAgentThinkingEventType = "agent.thinking"` - `type BetaManagedAgentsAgentMCPToolUseEvent struct{…}` Event emitted when the agent invokes a tool provided by an MCP server. - `ID string` Unique identifier for this event. - `Input map[string, any]` Input parameters for the tool call. - `MCPServerName string` Name of the MCP server providing the tool. - `Name string` Name of the MCP tool being used. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentMCPToolUseEventType` - `const BetaManagedAgentsAgentMCPToolUseEventTypeAgentMCPToolUse BetaManagedAgentsAgentMCPToolUseEventType = "agent.mcp_tool_use"` - `EvaluatedPermission BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission` AgentEvaluatedPermission enum - `const BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermissionAllow BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission = "allow"` - `const BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermissionAsk BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission = "ask"` - `const BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermissionDeny BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission = "deny"` - `SessionThreadID string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `type BetaManagedAgentsAgentMCPToolResultEvent struct{…}` Event representing the result of an MCP tool execution. - `ID string` Unique identifier for this event. - `MCPToolUseID string` The id of the `agent.mcp_tool_use` event this result corresponds to. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentMCPToolResultEventType` - `const BetaManagedAgentsAgentMCPToolResultEventTypeAgentMCPToolResult BetaManagedAgentsAgentMCPToolResultEventType = "agent.mcp_tool_result"` - `Content []BetaManagedAgentsAgentMCPToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `IsError bool` Whether the tool execution resulted in an error. - `type BetaManagedAgentsAgentToolUseEvent struct{…}` Event emitted when the agent invokes a built-in agent tool. - `ID string` Unique identifier for this event. - `Input map[string, any]` Input parameters for the tool call. - `Name string` Name of the agent tool being used. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentToolUseEventType` - `const BetaManagedAgentsAgentToolUseEventTypeAgentToolUse BetaManagedAgentsAgentToolUseEventType = "agent.tool_use"` - `EvaluatedPermission BetaManagedAgentsAgentToolUseEventEvaluatedPermission` AgentEvaluatedPermission enum - `const BetaManagedAgentsAgentToolUseEventEvaluatedPermissionAllow BetaManagedAgentsAgentToolUseEventEvaluatedPermission = "allow"` - `const BetaManagedAgentsAgentToolUseEventEvaluatedPermissionAsk BetaManagedAgentsAgentToolUseEventEvaluatedPermission = "ask"` - `const BetaManagedAgentsAgentToolUseEventEvaluatedPermissionDeny BetaManagedAgentsAgentToolUseEventEvaluatedPermission = "deny"` - `SessionThreadID string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `type BetaManagedAgentsAgentToolResultEvent struct{…}` Event representing the result of an agent tool execution. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `ToolUseID string` The id of the `agent.tool_use` event this result corresponds to. - `Type BetaManagedAgentsAgentToolResultEventType` - `const BetaManagedAgentsAgentToolResultEventTypeAgentToolResult BetaManagedAgentsAgentToolResultEventType = "agent.tool_result"` - `Content []BetaManagedAgentsAgentToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `IsError bool` Whether the tool execution resulted in an error. - `type BetaManagedAgentsAgentThreadMessageReceivedEvent struct{…}` Delivery event written to the target thread's input stream when an agent-to-agent message arrives. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsAgentThreadMessageReceivedEventContentUnion` Message content blocks. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `FromSessionThreadID string` Public `sthr_` ID of the thread that sent the message. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentThreadMessageReceivedEventType` - `const BetaManagedAgentsAgentThreadMessageReceivedEventTypeAgentThreadMessageReceived BetaManagedAgentsAgentThreadMessageReceivedEventType = "agent.thread_message_received"` - `FromAgentName string` Name of the callable agent this message came from. Absent when received from the primary agent. - `type BetaManagedAgentsAgentThreadMessageSentEvent struct{…}` Observability event emitted to the sender's output stream when an agent-to-agent message is sent. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsAgentThreadMessageSentEventContentUnion` Message content blocks. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `ProcessedAt Time` A timestamp in RFC 3339 format - `ToSessionThreadID string` Public `sthr_` ID of the thread the message was sent to. - `Type BetaManagedAgentsAgentThreadMessageSentEventType` - `const BetaManagedAgentsAgentThreadMessageSentEventTypeAgentThreadMessageSent BetaManagedAgentsAgentThreadMessageSentEventType = "agent.thread_message_sent"` - `ToAgentName string` Name of the callable agent this message was sent to. Absent when sent to the primary agent. - `type BetaManagedAgentsAgentThreadContextCompactedEvent struct{…}` Indicates that context compaction (summarization) occurred during the session. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentThreadContextCompactedEventType` - `const BetaManagedAgentsAgentThreadContextCompactedEventTypeAgentThreadContextCompacted BetaManagedAgentsAgentThreadContextCompactedEventType = "agent.thread_context_compacted"` - `type BetaManagedAgentsSessionErrorEvent struct{…}` An error event indicating a problem occurred during session execution. - `ID string` Unique identifier for this event. - `Error BetaManagedAgentsSessionErrorEventErrorUnion` An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on `retry_status` and `message` alone. - `type BetaManagedAgentsUnknownError struct{…}` An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on `retry_status` and `message` alone. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsUnknownErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `Type BetaManagedAgentsRetryStatusRetryingType` - `const BetaManagedAgentsRetryStatusRetryingTypeRetrying BetaManagedAgentsRetryStatusRetryingType = "retrying"` - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `Type BetaManagedAgentsRetryStatusExhaustedType` - `const BetaManagedAgentsRetryStatusExhaustedTypeExhausted BetaManagedAgentsRetryStatusExhaustedType = "exhausted"` - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsRetryStatusTerminalType` - `const BetaManagedAgentsRetryStatusTerminalTypeTerminal BetaManagedAgentsRetryStatusTerminalType = "terminal"` - `Type BetaManagedAgentsUnknownErrorType` - `const BetaManagedAgentsUnknownErrorTypeUnknownError BetaManagedAgentsUnknownErrorType = "unknown_error"` - `type BetaManagedAgentsModelOverloadedError struct{…}` The model is currently overloaded. Emitted after automatic retries are exhausted. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsModelOverloadedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsModelOverloadedErrorType` - `const BetaManagedAgentsModelOverloadedErrorTypeModelOverloadedError BetaManagedAgentsModelOverloadedErrorType = "model_overloaded_error"` - `type BetaManagedAgentsModelRateLimitedError struct{…}` The model request was rate-limited. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsModelRateLimitedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsModelRateLimitedErrorType` - `const BetaManagedAgentsModelRateLimitedErrorTypeModelRateLimitedError BetaManagedAgentsModelRateLimitedErrorType = "model_rate_limited_error"` - `type BetaManagedAgentsModelRequestFailedError struct{…}` A model request failed for a reason other than overload or rate-limiting. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsModelRequestFailedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsModelRequestFailedErrorType` - `const BetaManagedAgentsModelRequestFailedErrorTypeModelRequestFailedError BetaManagedAgentsModelRequestFailedErrorType = "model_request_failed_error"` - `type BetaManagedAgentsMCPConnectionFailedError struct{…}` Failed to connect to an MCP server. - `MCPServerName string` Name of the MCP server that failed to connect. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsMCPConnectionFailedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsMCPConnectionFailedErrorType` - `const BetaManagedAgentsMCPConnectionFailedErrorTypeMCPConnectionFailedError BetaManagedAgentsMCPConnectionFailedErrorType = "mcp_connection_failed_error"` - `type BetaManagedAgentsMCPAuthenticationFailedError struct{…}` Authentication to an MCP server failed. - `MCPServerName string` Name of the MCP server that failed authentication. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsMCPAuthenticationFailedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsMCPAuthenticationFailedErrorType` - `const BetaManagedAgentsMCPAuthenticationFailedErrorTypeMCPAuthenticationFailedError BetaManagedAgentsMCPAuthenticationFailedErrorType = "mcp_authentication_failed_error"` - `type BetaManagedAgentsBillingError struct{…}` The caller's organization or workspace cannot make model requests — out of credits or spend limit reached. Retrying with the same credentials will not succeed; the caller must resolve the billing state. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsBillingErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsBillingErrorType` - `const BetaManagedAgentsBillingErrorTypeBillingError BetaManagedAgentsBillingErrorType = "billing_error"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionErrorEventType` - `const BetaManagedAgentsSessionErrorEventTypeSessionError BetaManagedAgentsSessionErrorEventType = "session.error"` - `type BetaManagedAgentsSessionStatusRescheduledEvent struct{…}` Indicates the session is recovering from an error state and is rescheduled for execution. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionStatusRescheduledEventType` - `const BetaManagedAgentsSessionStatusRescheduledEventTypeSessionStatusRescheduled BetaManagedAgentsSessionStatusRescheduledEventType = "session.status_rescheduled"` - `type BetaManagedAgentsSessionStatusRunningEvent struct{…}` Indicates the session is actively running and the agent is working. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionStatusRunningEventType` - `const BetaManagedAgentsSessionStatusRunningEventTypeSessionStatusRunning BetaManagedAgentsSessionStatusRunningEventType = "session.status_running"` - `type BetaManagedAgentsSessionStatusIdleEvent struct{…}` Indicates the agent has paused and is awaiting user input. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `StopReason BetaManagedAgentsSessionStatusIdleEventStopReasonUnion` The agent completed its turn naturally and is ready for the next user message. - `type BetaManagedAgentsSessionEndTurn struct{…}` The agent completed its turn naturally and is ready for the next user message. - `Type BetaManagedAgentsSessionEndTurnType` - `const BetaManagedAgentsSessionEndTurnTypeEndTurn BetaManagedAgentsSessionEndTurnType = "end_turn"` - `type BetaManagedAgentsSessionRequiresAction struct{…}` The agent is idle waiting on one or more blocking user-input events (tool confirmation, custom tool result, etc.). Resolving all of them transitions the session back to running. - `EventIDs []string` The ids of events the agent is blocked on. Resolving fewer than all re-emits `session.status_idle` with the remainder. - `Type BetaManagedAgentsSessionRequiresActionType` - `const BetaManagedAgentsSessionRequiresActionTypeRequiresAction BetaManagedAgentsSessionRequiresActionType = "requires_action"` - `type BetaManagedAgentsSessionRetriesExhausted struct{…}` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `Type BetaManagedAgentsSessionRetriesExhaustedType` - `const BetaManagedAgentsSessionRetriesExhaustedTypeRetriesExhausted BetaManagedAgentsSessionRetriesExhaustedType = "retries_exhausted"` - `Type BetaManagedAgentsSessionStatusIdleEventType` - `const BetaManagedAgentsSessionStatusIdleEventTypeSessionStatusIdle BetaManagedAgentsSessionStatusIdleEventType = "session.status_idle"` - `type BetaManagedAgentsSessionStatusTerminatedEvent struct{…}` Indicates the session has terminated, either due to an error or completion. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionStatusTerminatedEventType` - `const BetaManagedAgentsSessionStatusTerminatedEventTypeSessionStatusTerminated BetaManagedAgentsSessionStatusTerminatedEventType = "session.status_terminated"` - `type BetaManagedAgentsSessionThreadCreatedEvent struct{…}` Emitted when a subagent is spawned as a new thread. Written to the parent thread's output stream so clients observing the session see child creation. - `ID string` Unique identifier for this event. - `AgentName string` Name of the callable agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public `sthr_` ID of the newly created thread. - `Type BetaManagedAgentsSessionThreadCreatedEventType` - `const BetaManagedAgentsSessionThreadCreatedEventTypeSessionThreadCreated BetaManagedAgentsSessionThreadCreatedEventType = "session.thread_created"` - `type BetaManagedAgentsSpanOutcomeEvaluationStartEvent struct{…}` Emitted when an outcome evaluation cycle begins. - `ID string` Unique identifier for this event. - `Iteration int64` 0-indexed revision cycle. 0 is the first evaluation; 1 is the re-evaluation after the first revision; etc. - `OutcomeID string` The `outc_` ID of the outcome being evaluated. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanOutcomeEvaluationStartEventType` - `const BetaManagedAgentsSpanOutcomeEvaluationStartEventTypeSpanOutcomeEvaluationStart BetaManagedAgentsSpanOutcomeEvaluationStartEventType = "span.outcome_evaluation_start"` - `type BetaManagedAgentsSpanOutcomeEvaluationEndEvent struct{…}` Emitted when an outcome evaluation cycle completes. Carries the verdict and aggregate token usage. A verdict of `needs_revision` means another evaluation cycle follows; `satisfied`, `max_iterations_reached`, `failed`, or `interrupted` are terminal — no further evaluation cycles follow. - `ID string` Unique identifier for this event. - `Explanation string` Human-readable explanation of the verdict. For `needs_revision`, describes which criteria failed and why. - `Iteration int64` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `OutcomeEvaluationStartID string` The id of the corresponding `span.outcome_evaluation_start` event. - `OutcomeID string` The `outc_` ID of the outcome being evaluated. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Result string` Evaluation verdict. 'satisfied': criteria met, session goes idle. 'needs_revision': criteria not met, another revision cycle follows. 'max_iterations_reached': evaluation budget exhausted with criteria still unmet — one final acknowledgment turn follows before the session goes idle, but no further evaluation runs. 'failed': grader determined the rubric does not apply to the deliverables. 'interrupted': user sent an interrupt while evaluation was in progress. - `Type BetaManagedAgentsSpanOutcomeEvaluationEndEventType` - `const BetaManagedAgentsSpanOutcomeEvaluationEndEventTypeSpanOutcomeEvaluationEnd BetaManagedAgentsSpanOutcomeEvaluationEndEventType = "span.outcome_evaluation_end"` - `Usage BetaManagedAgentsSpanModelUsage` Token usage for a single model request. - `CacheCreationInputTokens int64` Tokens used to create prompt cache in this request. - `CacheReadInputTokens int64` Tokens read from prompt cache in this request. - `InputTokens int64` Input tokens consumed by this request. - `OutputTokens int64` Output tokens generated by this request. - `Speed BetaManagedAgentsSpanModelUsageSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsSpanModelUsageSpeedStandard BetaManagedAgentsSpanModelUsageSpeed = "standard"` - `const BetaManagedAgentsSpanModelUsageSpeedFast BetaManagedAgentsSpanModelUsageSpeed = "fast"` - `type BetaManagedAgentsSpanModelRequestStartEvent struct{…}` Emitted when a model request is initiated by the agent. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanModelRequestStartEventType` - `const BetaManagedAgentsSpanModelRequestStartEventTypeSpanModelRequestStart BetaManagedAgentsSpanModelRequestStartEventType = "span.model_request_start"` - `type BetaManagedAgentsSpanModelRequestEndEvent struct{…}` Emitted when a model request completes. - `ID string` Unique identifier for this event. - `IsError bool` Whether the model request resulted in an error. - `ModelRequestStartID string` The id of the corresponding `span.model_request_start` event. - `ModelUsage BetaManagedAgentsSpanModelUsage` Token usage for a single model request. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanModelRequestEndEventType` - `const BetaManagedAgentsSpanModelRequestEndEventTypeSpanModelRequestEnd BetaManagedAgentsSpanModelRequestEndEventType = "span.model_request_end"` - `type BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent struct{…}` Periodic heartbeat emitted while an outcome evaluation cycle is in progress. Distinguishes 'evaluation is actively running' from 'evaluation is stuck' between the corresponding `span.outcome_evaluation_start` and `span.outcome_evaluation_end` events. - `ID string` Unique identifier for this event. - `Iteration int64` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `OutcomeID string` The `outc_` ID of the outcome being evaluated. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanOutcomeEvaluationOngoingEventType` - `const BetaManagedAgentsSpanOutcomeEvaluationOngoingEventTypeSpanOutcomeEvaluationOngoing BetaManagedAgentsSpanOutcomeEvaluationOngoingEventType = "span.outcome_evaluation_ongoing"` - `type BetaManagedAgentsUserDefineOutcomeEvent struct{…}` Echo of a `user.define_outcome` input event. Carries the server-generated `outcome_id` that subsequent `span.outcome_evaluation_*` events reference. - `ID string` Unique identifier for this event. - `Description string` What the agent should produce. Copied from the input event. - `MaxIterations int64` Evaluate-then-revise cycles before giving up. Default 3, max 20. - `OutcomeID string` Server-generated `outc_` ID for this outcome. Referenced by `span.outcome_evaluation_*` events and the session's `outcome_evaluations` list. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Rubric BetaManagedAgentsUserDefineOutcomeEventRubricUnion` Rubric for grading the quality of an outcome. - `type BetaManagedAgentsFileRubric struct{…}` Rubric referenced by a file uploaded via the Files API. - `FileID string` ID of the rubric file. - `Type BetaManagedAgentsFileRubricType` - `const BetaManagedAgentsFileRubricTypeFile BetaManagedAgentsFileRubricType = "file"` - `type BetaManagedAgentsTextRubric struct{…}` Rubric content provided inline as text. - `Content string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `Type BetaManagedAgentsTextRubricType` - `const BetaManagedAgentsTextRubricTypeText BetaManagedAgentsTextRubricType = "text"` - `Type BetaManagedAgentsUserDefineOutcomeEventType` - `const BetaManagedAgentsUserDefineOutcomeEventTypeUserDefineOutcome BetaManagedAgentsUserDefineOutcomeEventType = "user.define_outcome"` - `type BetaManagedAgentsSessionDeletedEvent struct{…}` Emitted when a session has been deleted. Terminates any active event stream — no further events will be emitted for this session. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionDeletedEventType` - `const BetaManagedAgentsSessionDeletedEventTypeSessionDeleted BetaManagedAgentsSessionDeletedEventType = "session.deleted"` - `type BetaManagedAgentsSessionThreadStatusRunningEvent struct{…}` A session thread has begun executing. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that started running. - `Type BetaManagedAgentsSessionThreadStatusRunningEventType` - `const BetaManagedAgentsSessionThreadStatusRunningEventTypeSessionThreadStatusRunning BetaManagedAgentsSessionThreadStatusRunningEventType = "session.thread_status_running"` - `type BetaManagedAgentsSessionThreadStatusIdleEvent struct{…}` A session thread has yielded and is awaiting input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that went idle. - `StopReason BetaManagedAgentsSessionThreadStatusIdleEventStopReasonUnion` The agent completed its turn naturally and is ready for the next user message. - `type BetaManagedAgentsSessionEndTurn struct{…}` The agent completed its turn naturally and is ready for the next user message. - `type BetaManagedAgentsSessionRequiresAction struct{…}` The agent is idle waiting on one or more blocking user-input events (tool confirmation, custom tool result, etc.). Resolving all of them transitions the session back to running. - `type BetaManagedAgentsSessionRetriesExhausted struct{…}` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `Type BetaManagedAgentsSessionThreadStatusIdleEventType` - `const BetaManagedAgentsSessionThreadStatusIdleEventTypeSessionThreadStatusIdle BetaManagedAgentsSessionThreadStatusIdleEventType = "session.thread_status_idle"` - `type BetaManagedAgentsSessionThreadStatusTerminatedEvent struct{…}` A session thread has terminated and will accept no further input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that terminated. - `Type BetaManagedAgentsSessionThreadStatusTerminatedEventType` - `const BetaManagedAgentsSessionThreadStatusTerminatedEventTypeSessionThreadStatusTerminated BetaManagedAgentsSessionThreadStatusTerminatedEventType = "session.thread_status_terminated"` - `type BetaManagedAgentsUserToolResultEvent struct{…}` Event sent by the client providing the result of an agent-toolset tool execution. Only valid on `self_hosted` environments, where sandbox-routed tools are executed by the client rather than the server. - `ID string` Unique identifier for this event. - `ToolUseID string` The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserToolResultEventType` - `const BetaManagedAgentsUserToolResultEventTypeUserToolResult BetaManagedAgentsUserToolResultEventType = "user.tool_result"` - `Content []BetaManagedAgentsUserToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `IsError bool` Whether the tool execution resulted in an error. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Routes this result to a subagent thread. Copy from the `agent.tool_use` event's `session_thread_id`. - `type BetaManagedAgentsSessionThreadStatusRescheduledEvent struct{…}` A session thread hit a transient error and is retrying automatically. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that is retrying. - `Type BetaManagedAgentsSessionThreadStatusRescheduledEventType` - `const BetaManagedAgentsSessionThreadStatusRescheduledEventTypeSessionThreadStatusRescheduled BetaManagedAgentsSessionThreadStatusRescheduledEventType = "session.thread_status_rescheduled"` - `type BetaManagedAgentsSessionUpdatedEvent struct{…}` Emitted when an UpdateSession request changed at least one field. Carries only the fields that changed; absent fields were not part of the update. The new configuration applies from the next turn. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionUpdatedEventType` - `const BetaManagedAgentsSessionUpdatedEventTypeSessionUpdated BetaManagedAgentsSessionUpdatedEventType = "session.updated"` - `Agent BetaManagedAgentsSessionAgent` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Multiagent BetaManagedAgentsSessionMultiagentCoordinator` Resolved coordinator topology with full agent definitions for each roster member. - `Agents []BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `Name string` - `Skills []BetaManagedAgentsSessionThreadAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsSessionThreadAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsSessionThreadAgentType` - `const BetaManagedAgentsSessionThreadAgentTypeAgent BetaManagedAgentsSessionThreadAgentType = "agent"` - `Version int64` - `Type BetaManagedAgentsSessionMultiagentCoordinatorType` - `const BetaManagedAgentsSessionMultiagentCoordinatorTypeCoordinator BetaManagedAgentsSessionMultiagentCoordinatorType = "coordinator"` - `Name string` - `Skills []BetaManagedAgentsSessionAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `System string` - `Tools []BetaManagedAgentsSessionAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `type BetaManagedAgentsMCPToolset struct{…}` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Type BetaManagedAgentsSessionAgentType` - `const BetaManagedAgentsSessionAgentTypeAgent BetaManagedAgentsSessionAgentType = "agent"` - `Version int64` - `Metadata map[string, string]` The session's full metadata bag after the update. Present when the update set non-empty metadata; absent when metadata was unchanged or cleared to empty. - `Title string` The session's new title. Present only when the update changed it. # Events ## List Session Thread Events `client.Beta.Sessions.Threads.Events.List(ctx, threadID, params) (*PageCursor[BetaManagedAgentsSessionEventUnion], error)` **get** `/v1/sessions/{session_id}/threads/{thread_id}/events` List Session Thread Events ### Parameters - `threadID string` - `params BetaSessionThreadEventListParams` - `SessionID param.Field[string]` Path param: Path parameter session_id - `Limit param.Field[int64]` Query param: Query parameter for limit - `Page param.Field[string]` Query param: Query parameter for page - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsSessionEventUnion interface{…}` Union type for all event types in a session. - `type BetaManagedAgentsUserMessageEvent struct{…}` A user message event in the session conversation. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsUserMessageEventContentUnion` Array of content blocks comprising the user message. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `const BetaManagedAgentsTextBlockTypeText BetaManagedAgentsTextBlockType = "text"` - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `Source BetaManagedAgentsImageBlockSourceUnion` Union type for image source variants. - `type BetaManagedAgentsBase64ImageSource struct{…}` Base64-encoded image data. - `Data string` Base64-encoded image data. - `MediaType string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `Type BetaManagedAgentsBase64ImageSourceType` - `const BetaManagedAgentsBase64ImageSourceTypeBase64 BetaManagedAgentsBase64ImageSourceType = "base64"` - `type BetaManagedAgentsURLImageSource struct{…}` Image referenced by URL. - `Type BetaManagedAgentsURLImageSourceType` - `const BetaManagedAgentsURLImageSourceTypeURL BetaManagedAgentsURLImageSourceType = "url"` - `URL string` URL of the image to fetch. - `type BetaManagedAgentsFileImageSource struct{…}` Image referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileImageSourceType` - `const BetaManagedAgentsFileImageSourceTypeFile BetaManagedAgentsFileImageSourceType = "file"` - `Type BetaManagedAgentsImageBlockType` - `const BetaManagedAgentsImageBlockTypeImage BetaManagedAgentsImageBlockType = "image"` - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `Source BetaManagedAgentsDocumentBlockSourceUnion` Union type for document source variants. - `type BetaManagedAgentsBase64DocumentSource struct{…}` Base64-encoded document data. - `Data string` Base64-encoded document data. - `MediaType string` MIME type of the document (e.g., "application/pdf"). - `Type BetaManagedAgentsBase64DocumentSourceType` - `const BetaManagedAgentsBase64DocumentSourceTypeBase64 BetaManagedAgentsBase64DocumentSourceType = "base64"` - `type BetaManagedAgentsPlainTextDocumentSource struct{…}` Plain text document content. - `Data string` The plain text content. - `MediaType BetaManagedAgentsPlainTextDocumentSourceMediaType` MIME type of the text content. Must be "text/plain". - `const BetaManagedAgentsPlainTextDocumentSourceMediaTypeTextPlain BetaManagedAgentsPlainTextDocumentSourceMediaType = "text/plain"` - `Type BetaManagedAgentsPlainTextDocumentSourceType` - `const BetaManagedAgentsPlainTextDocumentSourceTypeText BetaManagedAgentsPlainTextDocumentSourceType = "text"` - `type BetaManagedAgentsURLDocumentSource struct{…}` Document referenced by URL. - `Type BetaManagedAgentsURLDocumentSourceType` - `const BetaManagedAgentsURLDocumentSourceTypeURL BetaManagedAgentsURLDocumentSourceType = "url"` - `URL string` URL of the document to fetch. - `type BetaManagedAgentsFileDocumentSource struct{…}` Document referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileDocumentSourceType` - `const BetaManagedAgentsFileDocumentSourceTypeFile BetaManagedAgentsFileDocumentSourceType = "file"` - `Type BetaManagedAgentsDocumentBlockType` - `const BetaManagedAgentsDocumentBlockTypeDocument BetaManagedAgentsDocumentBlockType = "document"` - `Context string` Additional context about the document for the model. - `Title string` The title of the document. - `Type BetaManagedAgentsUserMessageEventType` - `const BetaManagedAgentsUserMessageEventTypeUserMessage BetaManagedAgentsUserMessageEventType = "user.message"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `type BetaManagedAgentsUserInterruptEvent struct{…}` An interrupt event that pauses agent execution and returns control to the user. - `ID string` Unique identifier for this event. - `Type BetaManagedAgentsUserInterruptEventType` - `const BetaManagedAgentsUserInterruptEventTypeUserInterrupt BetaManagedAgentsUserInterruptEventType = "user.interrupt"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. - `type BetaManagedAgentsUserToolConfirmationEvent struct{…}` A tool confirmation event that approves or denies a pending tool execution. - `ID string` Unique identifier for this event. - `Result BetaManagedAgentsUserToolConfirmationEventResult` UserToolConfirmationResult enum - `const BetaManagedAgentsUserToolConfirmationEventResultAllow BetaManagedAgentsUserToolConfirmationEventResult = "allow"` - `const BetaManagedAgentsUserToolConfirmationEventResultDeny BetaManagedAgentsUserToolConfirmationEventResult = "deny"` - `ToolUseID string` The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserToolConfirmationEventType` - `const BetaManagedAgentsUserToolConfirmationEventTypeUserToolConfirmation BetaManagedAgentsUserToolConfirmationEventType = "user.tool_confirmation"` - `DenyMessage string` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` When set, the confirmation routes to this subagent's thread rather than the primary. Echo this from the `session_thread_id` on the `agent.tool_use` or `agent.mcp_tool_use` event that prompted the approval. - `type BetaManagedAgentsUserCustomToolResultEvent struct{…}` Event sent by the client providing the result of a custom tool execution. - `ID string` Unique identifier for this event. - `CustomToolUseID string` The id of the `agent.custom_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserCustomToolResultEventType` - `const BetaManagedAgentsUserCustomToolResultEventTypeUserCustomToolResult BetaManagedAgentsUserCustomToolResultEventType = "user.custom_tool_result"` - `Content []BetaManagedAgentsUserCustomToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `Citations BetaManagedAgentsSearchResultCitations` Citation settings for a search result. - `Enabled bool` Whether citations are enabled for this search result. - `Content []BetaManagedAgentsSearchResultContent` Array of text content blocks from the search result. - `Text string` The text content. - `Type BetaManagedAgentsSearchResultContentType` - `const BetaManagedAgentsSearchResultContentTypeText BetaManagedAgentsSearchResultContentType = "text"` - `Source string` The URL source of the search result. - `Title string` The title of the search result. - `Type BetaManagedAgentsSearchResultBlockType` - `const BetaManagedAgentsSearchResultBlockTypeSearchResult BetaManagedAgentsSearchResultBlockType = "search_result"` - `IsError bool` Whether the tool execution resulted in an error. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Routes this result to a subagent thread. Copy from the `agent.custom_tool_use` event's `session_thread_id`. - `type BetaManagedAgentsAgentCustomToolUseEvent struct{…}` Event emitted when the agent calls a custom tool. The session goes idle until the client sends a `user.custom_tool_result` event with the result. - `ID string` Unique identifier for this event. - `Input map[string, any]` Input parameters for the tool call. - `Name string` Name of the custom tool being called. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentCustomToolUseEventType` - `const BetaManagedAgentsAgentCustomToolUseEventTypeAgentCustomToolUse BetaManagedAgentsAgentCustomToolUseEventType = "agent.custom_tool_use"` - `SessionThreadID string` When set, this event was cross-posted from a subagent's thread to surface its custom tool use on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.custom_tool_result` event to route the result back. - `type BetaManagedAgentsAgentMessageEvent struct{…}` An agent response event in the session conversation. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsTextBlock` Array of text blocks comprising the agent response. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentMessageEventType` - `const BetaManagedAgentsAgentMessageEventTypeAgentMessage BetaManagedAgentsAgentMessageEventType = "agent.message"` - `type BetaManagedAgentsAgentThinkingEvent struct{…}` Indicates the agent is making forward progress via extended thinking. A progress signal, not a content carrier. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentThinkingEventType` - `const BetaManagedAgentsAgentThinkingEventTypeAgentThinking BetaManagedAgentsAgentThinkingEventType = "agent.thinking"` - `type BetaManagedAgentsAgentMCPToolUseEvent struct{…}` Event emitted when the agent invokes a tool provided by an MCP server. - `ID string` Unique identifier for this event. - `Input map[string, any]` Input parameters for the tool call. - `MCPServerName string` Name of the MCP server providing the tool. - `Name string` Name of the MCP tool being used. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentMCPToolUseEventType` - `const BetaManagedAgentsAgentMCPToolUseEventTypeAgentMCPToolUse BetaManagedAgentsAgentMCPToolUseEventType = "agent.mcp_tool_use"` - `EvaluatedPermission BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission` AgentEvaluatedPermission enum - `const BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermissionAllow BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission = "allow"` - `const BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermissionAsk BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission = "ask"` - `const BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermissionDeny BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission = "deny"` - `SessionThreadID string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `type BetaManagedAgentsAgentMCPToolResultEvent struct{…}` Event representing the result of an MCP tool execution. - `ID string` Unique identifier for this event. - `MCPToolUseID string` The id of the `agent.mcp_tool_use` event this result corresponds to. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentMCPToolResultEventType` - `const BetaManagedAgentsAgentMCPToolResultEventTypeAgentMCPToolResult BetaManagedAgentsAgentMCPToolResultEventType = "agent.mcp_tool_result"` - `Content []BetaManagedAgentsAgentMCPToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `IsError bool` Whether the tool execution resulted in an error. - `type BetaManagedAgentsAgentToolUseEvent struct{…}` Event emitted when the agent invokes a built-in agent tool. - `ID string` Unique identifier for this event. - `Input map[string, any]` Input parameters for the tool call. - `Name string` Name of the agent tool being used. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentToolUseEventType` - `const BetaManagedAgentsAgentToolUseEventTypeAgentToolUse BetaManagedAgentsAgentToolUseEventType = "agent.tool_use"` - `EvaluatedPermission BetaManagedAgentsAgentToolUseEventEvaluatedPermission` AgentEvaluatedPermission enum - `const BetaManagedAgentsAgentToolUseEventEvaluatedPermissionAllow BetaManagedAgentsAgentToolUseEventEvaluatedPermission = "allow"` - `const BetaManagedAgentsAgentToolUseEventEvaluatedPermissionAsk BetaManagedAgentsAgentToolUseEventEvaluatedPermission = "ask"` - `const BetaManagedAgentsAgentToolUseEventEvaluatedPermissionDeny BetaManagedAgentsAgentToolUseEventEvaluatedPermission = "deny"` - `SessionThreadID string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `type BetaManagedAgentsAgentToolResultEvent struct{…}` Event representing the result of an agent tool execution. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `ToolUseID string` The id of the `agent.tool_use` event this result corresponds to. - `Type BetaManagedAgentsAgentToolResultEventType` - `const BetaManagedAgentsAgentToolResultEventTypeAgentToolResult BetaManagedAgentsAgentToolResultEventType = "agent.tool_result"` - `Content []BetaManagedAgentsAgentToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `IsError bool` Whether the tool execution resulted in an error. - `type BetaManagedAgentsAgentThreadMessageReceivedEvent struct{…}` Delivery event written to the target thread's input stream when an agent-to-agent message arrives. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsAgentThreadMessageReceivedEventContentUnion` Message content blocks. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `FromSessionThreadID string` Public `sthr_` ID of the thread that sent the message. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentThreadMessageReceivedEventType` - `const BetaManagedAgentsAgentThreadMessageReceivedEventTypeAgentThreadMessageReceived BetaManagedAgentsAgentThreadMessageReceivedEventType = "agent.thread_message_received"` - `FromAgentName string` Name of the callable agent this message came from. Absent when received from the primary agent. - `type BetaManagedAgentsAgentThreadMessageSentEvent struct{…}` Observability event emitted to the sender's output stream when an agent-to-agent message is sent. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsAgentThreadMessageSentEventContentUnion` Message content blocks. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `ProcessedAt Time` A timestamp in RFC 3339 format - `ToSessionThreadID string` Public `sthr_` ID of the thread the message was sent to. - `Type BetaManagedAgentsAgentThreadMessageSentEventType` - `const BetaManagedAgentsAgentThreadMessageSentEventTypeAgentThreadMessageSent BetaManagedAgentsAgentThreadMessageSentEventType = "agent.thread_message_sent"` - `ToAgentName string` Name of the callable agent this message was sent to. Absent when sent to the primary agent. - `type BetaManagedAgentsAgentThreadContextCompactedEvent struct{…}` Indicates that context compaction (summarization) occurred during the session. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentThreadContextCompactedEventType` - `const BetaManagedAgentsAgentThreadContextCompactedEventTypeAgentThreadContextCompacted BetaManagedAgentsAgentThreadContextCompactedEventType = "agent.thread_context_compacted"` - `type BetaManagedAgentsSessionErrorEvent struct{…}` An error event indicating a problem occurred during session execution. - `ID string` Unique identifier for this event. - `Error BetaManagedAgentsSessionErrorEventErrorUnion` An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on `retry_status` and `message` alone. - `type BetaManagedAgentsUnknownError struct{…}` An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on `retry_status` and `message` alone. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsUnknownErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `Type BetaManagedAgentsRetryStatusRetryingType` - `const BetaManagedAgentsRetryStatusRetryingTypeRetrying BetaManagedAgentsRetryStatusRetryingType = "retrying"` - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `Type BetaManagedAgentsRetryStatusExhaustedType` - `const BetaManagedAgentsRetryStatusExhaustedTypeExhausted BetaManagedAgentsRetryStatusExhaustedType = "exhausted"` - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsRetryStatusTerminalType` - `const BetaManagedAgentsRetryStatusTerminalTypeTerminal BetaManagedAgentsRetryStatusTerminalType = "terminal"` - `Type BetaManagedAgentsUnknownErrorType` - `const BetaManagedAgentsUnknownErrorTypeUnknownError BetaManagedAgentsUnknownErrorType = "unknown_error"` - `type BetaManagedAgentsModelOverloadedError struct{…}` The model is currently overloaded. Emitted after automatic retries are exhausted. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsModelOverloadedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsModelOverloadedErrorType` - `const BetaManagedAgentsModelOverloadedErrorTypeModelOverloadedError BetaManagedAgentsModelOverloadedErrorType = "model_overloaded_error"` - `type BetaManagedAgentsModelRateLimitedError struct{…}` The model request was rate-limited. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsModelRateLimitedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsModelRateLimitedErrorType` - `const BetaManagedAgentsModelRateLimitedErrorTypeModelRateLimitedError BetaManagedAgentsModelRateLimitedErrorType = "model_rate_limited_error"` - `type BetaManagedAgentsModelRequestFailedError struct{…}` A model request failed for a reason other than overload or rate-limiting. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsModelRequestFailedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsModelRequestFailedErrorType` - `const BetaManagedAgentsModelRequestFailedErrorTypeModelRequestFailedError BetaManagedAgentsModelRequestFailedErrorType = "model_request_failed_error"` - `type BetaManagedAgentsMCPConnectionFailedError struct{…}` Failed to connect to an MCP server. - `MCPServerName string` Name of the MCP server that failed to connect. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsMCPConnectionFailedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsMCPConnectionFailedErrorType` - `const BetaManagedAgentsMCPConnectionFailedErrorTypeMCPConnectionFailedError BetaManagedAgentsMCPConnectionFailedErrorType = "mcp_connection_failed_error"` - `type BetaManagedAgentsMCPAuthenticationFailedError struct{…}` Authentication to an MCP server failed. - `MCPServerName string` Name of the MCP server that failed authentication. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsMCPAuthenticationFailedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsMCPAuthenticationFailedErrorType` - `const BetaManagedAgentsMCPAuthenticationFailedErrorTypeMCPAuthenticationFailedError BetaManagedAgentsMCPAuthenticationFailedErrorType = "mcp_authentication_failed_error"` - `type BetaManagedAgentsBillingError struct{…}` The caller's organization or workspace cannot make model requests — out of credits or spend limit reached. Retrying with the same credentials will not succeed; the caller must resolve the billing state. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsBillingErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsBillingErrorType` - `const BetaManagedAgentsBillingErrorTypeBillingError BetaManagedAgentsBillingErrorType = "billing_error"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionErrorEventType` - `const BetaManagedAgentsSessionErrorEventTypeSessionError BetaManagedAgentsSessionErrorEventType = "session.error"` - `type BetaManagedAgentsSessionStatusRescheduledEvent struct{…}` Indicates the session is recovering from an error state and is rescheduled for execution. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionStatusRescheduledEventType` - `const BetaManagedAgentsSessionStatusRescheduledEventTypeSessionStatusRescheduled BetaManagedAgentsSessionStatusRescheduledEventType = "session.status_rescheduled"` - `type BetaManagedAgentsSessionStatusRunningEvent struct{…}` Indicates the session is actively running and the agent is working. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionStatusRunningEventType` - `const BetaManagedAgentsSessionStatusRunningEventTypeSessionStatusRunning BetaManagedAgentsSessionStatusRunningEventType = "session.status_running"` - `type BetaManagedAgentsSessionStatusIdleEvent struct{…}` Indicates the agent has paused and is awaiting user input. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `StopReason BetaManagedAgentsSessionStatusIdleEventStopReasonUnion` The agent completed its turn naturally and is ready for the next user message. - `type BetaManagedAgentsSessionEndTurn struct{…}` The agent completed its turn naturally and is ready for the next user message. - `Type BetaManagedAgentsSessionEndTurnType` - `const BetaManagedAgentsSessionEndTurnTypeEndTurn BetaManagedAgentsSessionEndTurnType = "end_turn"` - `type BetaManagedAgentsSessionRequiresAction struct{…}` The agent is idle waiting on one or more blocking user-input events (tool confirmation, custom tool result, etc.). Resolving all of them transitions the session back to running. - `EventIDs []string` The ids of events the agent is blocked on. Resolving fewer than all re-emits `session.status_idle` with the remainder. - `Type BetaManagedAgentsSessionRequiresActionType` - `const BetaManagedAgentsSessionRequiresActionTypeRequiresAction BetaManagedAgentsSessionRequiresActionType = "requires_action"` - `type BetaManagedAgentsSessionRetriesExhausted struct{…}` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `Type BetaManagedAgentsSessionRetriesExhaustedType` - `const BetaManagedAgentsSessionRetriesExhaustedTypeRetriesExhausted BetaManagedAgentsSessionRetriesExhaustedType = "retries_exhausted"` - `Type BetaManagedAgentsSessionStatusIdleEventType` - `const BetaManagedAgentsSessionStatusIdleEventTypeSessionStatusIdle BetaManagedAgentsSessionStatusIdleEventType = "session.status_idle"` - `type BetaManagedAgentsSessionStatusTerminatedEvent struct{…}` Indicates the session has terminated, either due to an error or completion. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionStatusTerminatedEventType` - `const BetaManagedAgentsSessionStatusTerminatedEventTypeSessionStatusTerminated BetaManagedAgentsSessionStatusTerminatedEventType = "session.status_terminated"` - `type BetaManagedAgentsSessionThreadCreatedEvent struct{…}` Emitted when a subagent is spawned as a new thread. Written to the parent thread's output stream so clients observing the session see child creation. - `ID string` Unique identifier for this event. - `AgentName string` Name of the callable agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public `sthr_` ID of the newly created thread. - `Type BetaManagedAgentsSessionThreadCreatedEventType` - `const BetaManagedAgentsSessionThreadCreatedEventTypeSessionThreadCreated BetaManagedAgentsSessionThreadCreatedEventType = "session.thread_created"` - `type BetaManagedAgentsSpanOutcomeEvaluationStartEvent struct{…}` Emitted when an outcome evaluation cycle begins. - `ID string` Unique identifier for this event. - `Iteration int64` 0-indexed revision cycle. 0 is the first evaluation; 1 is the re-evaluation after the first revision; etc. - `OutcomeID string` The `outc_` ID of the outcome being evaluated. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanOutcomeEvaluationStartEventType` - `const BetaManagedAgentsSpanOutcomeEvaluationStartEventTypeSpanOutcomeEvaluationStart BetaManagedAgentsSpanOutcomeEvaluationStartEventType = "span.outcome_evaluation_start"` - `type BetaManagedAgentsSpanOutcomeEvaluationEndEvent struct{…}` Emitted when an outcome evaluation cycle completes. Carries the verdict and aggregate token usage. A verdict of `needs_revision` means another evaluation cycle follows; `satisfied`, `max_iterations_reached`, `failed`, or `interrupted` are terminal — no further evaluation cycles follow. - `ID string` Unique identifier for this event. - `Explanation string` Human-readable explanation of the verdict. For `needs_revision`, describes which criteria failed and why. - `Iteration int64` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `OutcomeEvaluationStartID string` The id of the corresponding `span.outcome_evaluation_start` event. - `OutcomeID string` The `outc_` ID of the outcome being evaluated. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Result string` Evaluation verdict. 'satisfied': criteria met, session goes idle. 'needs_revision': criteria not met, another revision cycle follows. 'max_iterations_reached': evaluation budget exhausted with criteria still unmet — one final acknowledgment turn follows before the session goes idle, but no further evaluation runs. 'failed': grader determined the rubric does not apply to the deliverables. 'interrupted': user sent an interrupt while evaluation was in progress. - `Type BetaManagedAgentsSpanOutcomeEvaluationEndEventType` - `const BetaManagedAgentsSpanOutcomeEvaluationEndEventTypeSpanOutcomeEvaluationEnd BetaManagedAgentsSpanOutcomeEvaluationEndEventType = "span.outcome_evaluation_end"` - `Usage BetaManagedAgentsSpanModelUsage` Token usage for a single model request. - `CacheCreationInputTokens int64` Tokens used to create prompt cache in this request. - `CacheReadInputTokens int64` Tokens read from prompt cache in this request. - `InputTokens int64` Input tokens consumed by this request. - `OutputTokens int64` Output tokens generated by this request. - `Speed BetaManagedAgentsSpanModelUsageSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsSpanModelUsageSpeedStandard BetaManagedAgentsSpanModelUsageSpeed = "standard"` - `const BetaManagedAgentsSpanModelUsageSpeedFast BetaManagedAgentsSpanModelUsageSpeed = "fast"` - `type BetaManagedAgentsSpanModelRequestStartEvent struct{…}` Emitted when a model request is initiated by the agent. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanModelRequestStartEventType` - `const BetaManagedAgentsSpanModelRequestStartEventTypeSpanModelRequestStart BetaManagedAgentsSpanModelRequestStartEventType = "span.model_request_start"` - `type BetaManagedAgentsSpanModelRequestEndEvent struct{…}` Emitted when a model request completes. - `ID string` Unique identifier for this event. - `IsError bool` Whether the model request resulted in an error. - `ModelRequestStartID string` The id of the corresponding `span.model_request_start` event. - `ModelUsage BetaManagedAgentsSpanModelUsage` Token usage for a single model request. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanModelRequestEndEventType` - `const BetaManagedAgentsSpanModelRequestEndEventTypeSpanModelRequestEnd BetaManagedAgentsSpanModelRequestEndEventType = "span.model_request_end"` - `type BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent struct{…}` Periodic heartbeat emitted while an outcome evaluation cycle is in progress. Distinguishes 'evaluation is actively running' from 'evaluation is stuck' between the corresponding `span.outcome_evaluation_start` and `span.outcome_evaluation_end` events. - `ID string` Unique identifier for this event. - `Iteration int64` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `OutcomeID string` The `outc_` ID of the outcome being evaluated. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanOutcomeEvaluationOngoingEventType` - `const BetaManagedAgentsSpanOutcomeEvaluationOngoingEventTypeSpanOutcomeEvaluationOngoing BetaManagedAgentsSpanOutcomeEvaluationOngoingEventType = "span.outcome_evaluation_ongoing"` - `type BetaManagedAgentsUserDefineOutcomeEvent struct{…}` Echo of a `user.define_outcome` input event. Carries the server-generated `outcome_id` that subsequent `span.outcome_evaluation_*` events reference. - `ID string` Unique identifier for this event. - `Description string` What the agent should produce. Copied from the input event. - `MaxIterations int64` Evaluate-then-revise cycles before giving up. Default 3, max 20. - `OutcomeID string` Server-generated `outc_` ID for this outcome. Referenced by `span.outcome_evaluation_*` events and the session's `outcome_evaluations` list. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Rubric BetaManagedAgentsUserDefineOutcomeEventRubricUnion` Rubric for grading the quality of an outcome. - `type BetaManagedAgentsFileRubric struct{…}` Rubric referenced by a file uploaded via the Files API. - `FileID string` ID of the rubric file. - `Type BetaManagedAgentsFileRubricType` - `const BetaManagedAgentsFileRubricTypeFile BetaManagedAgentsFileRubricType = "file"` - `type BetaManagedAgentsTextRubric struct{…}` Rubric content provided inline as text. - `Content string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `Type BetaManagedAgentsTextRubricType` - `const BetaManagedAgentsTextRubricTypeText BetaManagedAgentsTextRubricType = "text"` - `Type BetaManagedAgentsUserDefineOutcomeEventType` - `const BetaManagedAgentsUserDefineOutcomeEventTypeUserDefineOutcome BetaManagedAgentsUserDefineOutcomeEventType = "user.define_outcome"` - `type BetaManagedAgentsSessionDeletedEvent struct{…}` Emitted when a session has been deleted. Terminates any active event stream — no further events will be emitted for this session. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionDeletedEventType` - `const BetaManagedAgentsSessionDeletedEventTypeSessionDeleted BetaManagedAgentsSessionDeletedEventType = "session.deleted"` - `type BetaManagedAgentsSessionThreadStatusRunningEvent struct{…}` A session thread has begun executing. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that started running. - `Type BetaManagedAgentsSessionThreadStatusRunningEventType` - `const BetaManagedAgentsSessionThreadStatusRunningEventTypeSessionThreadStatusRunning BetaManagedAgentsSessionThreadStatusRunningEventType = "session.thread_status_running"` - `type BetaManagedAgentsSessionThreadStatusIdleEvent struct{…}` A session thread has yielded and is awaiting input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that went idle. - `StopReason BetaManagedAgentsSessionThreadStatusIdleEventStopReasonUnion` The agent completed its turn naturally and is ready for the next user message. - `type BetaManagedAgentsSessionEndTurn struct{…}` The agent completed its turn naturally and is ready for the next user message. - `type BetaManagedAgentsSessionRequiresAction struct{…}` The agent is idle waiting on one or more blocking user-input events (tool confirmation, custom tool result, etc.). Resolving all of them transitions the session back to running. - `type BetaManagedAgentsSessionRetriesExhausted struct{…}` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `Type BetaManagedAgentsSessionThreadStatusIdleEventType` - `const BetaManagedAgentsSessionThreadStatusIdleEventTypeSessionThreadStatusIdle BetaManagedAgentsSessionThreadStatusIdleEventType = "session.thread_status_idle"` - `type BetaManagedAgentsSessionThreadStatusTerminatedEvent struct{…}` A session thread has terminated and will accept no further input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that terminated. - `Type BetaManagedAgentsSessionThreadStatusTerminatedEventType` - `const BetaManagedAgentsSessionThreadStatusTerminatedEventTypeSessionThreadStatusTerminated BetaManagedAgentsSessionThreadStatusTerminatedEventType = "session.thread_status_terminated"` - `type BetaManagedAgentsUserToolResultEvent struct{…}` Event sent by the client providing the result of an agent-toolset tool execution. Only valid on `self_hosted` environments, where sandbox-routed tools are executed by the client rather than the server. - `ID string` Unique identifier for this event. - `ToolUseID string` The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserToolResultEventType` - `const BetaManagedAgentsUserToolResultEventTypeUserToolResult BetaManagedAgentsUserToolResultEventType = "user.tool_result"` - `Content []BetaManagedAgentsUserToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `IsError bool` Whether the tool execution resulted in an error. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Routes this result to a subagent thread. Copy from the `agent.tool_use` event's `session_thread_id`. - `type BetaManagedAgentsSessionThreadStatusRescheduledEvent struct{…}` A session thread hit a transient error and is retrying automatically. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that is retrying. - `Type BetaManagedAgentsSessionThreadStatusRescheduledEventType` - `const BetaManagedAgentsSessionThreadStatusRescheduledEventTypeSessionThreadStatusRescheduled BetaManagedAgentsSessionThreadStatusRescheduledEventType = "session.thread_status_rescheduled"` - `type BetaManagedAgentsSessionUpdatedEvent struct{…}` Emitted when an UpdateSession request changed at least one field. Carries only the fields that changed; absent fields were not part of the update. The new configuration applies from the next turn. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionUpdatedEventType` - `const BetaManagedAgentsSessionUpdatedEventTypeSessionUpdated BetaManagedAgentsSessionUpdatedEventType = "session.updated"` - `Agent BetaManagedAgentsSessionAgent` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Multiagent BetaManagedAgentsSessionMultiagentCoordinator` Resolved coordinator topology with full agent definitions for each roster member. - `Agents []BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `Name string` - `Skills []BetaManagedAgentsSessionThreadAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsSessionThreadAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsSessionThreadAgentType` - `const BetaManagedAgentsSessionThreadAgentTypeAgent BetaManagedAgentsSessionThreadAgentType = "agent"` - `Version int64` - `Type BetaManagedAgentsSessionMultiagentCoordinatorType` - `const BetaManagedAgentsSessionMultiagentCoordinatorTypeCoordinator BetaManagedAgentsSessionMultiagentCoordinatorType = "coordinator"` - `Name string` - `Skills []BetaManagedAgentsSessionAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `System string` - `Tools []BetaManagedAgentsSessionAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `type BetaManagedAgentsMCPToolset struct{…}` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Type BetaManagedAgentsSessionAgentType` - `const BetaManagedAgentsSessionAgentTypeAgent BetaManagedAgentsSessionAgentType = "agent"` - `Version int64` - `Metadata map[string, string]` The session's full metadata bag after the update. Present when the update set non-empty metadata; absent when metadata was unchanged or cleared to empty. - `Title string` The session's new title. Present only when the update changed it. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) page, err := client.Beta.Sessions.Threads.Events.List( context.TODO(), "sthr_011CZkZVWa6oIjw0rgXZpnBt", anthropic.BetaSessionThreadEventListParams{ SessionID: "sesn_011CZkZAtmR3yMPDzynEDxu7", }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "data": [ { "id": "sevt_011CZkZGOp0iBcp4kaQSihUmy", "content": [ { "text": "Where is my order #1234?", "type": "text" } ], "type": "user.message", "processed_at": "2026-03-15T10:00:00Z" } ], "next_page": "next_page" } ``` ## Stream Session Thread Events `client.Beta.Sessions.Threads.Events.Stream(ctx, threadID, params) (*BetaManagedAgentsStreamSessionThreadEventsUnion, error)` **get** `/v1/sessions/{session_id}/threads/{thread_id}/stream` Stream Session Thread Events ### Parameters - `threadID string` - `params BetaSessionThreadEventStreamParams` - `SessionID param.Field[string]` Path param: Path parameter session_id - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsStreamSessionThreadEventsUnion interface{…}` Server-sent event in a single thread's stream. - `type BetaManagedAgentsUserMessageEvent struct{…}` A user message event in the session conversation. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsUserMessageEventContentUnion` Array of content blocks comprising the user message. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `const BetaManagedAgentsTextBlockTypeText BetaManagedAgentsTextBlockType = "text"` - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `Source BetaManagedAgentsImageBlockSourceUnion` Union type for image source variants. - `type BetaManagedAgentsBase64ImageSource struct{…}` Base64-encoded image data. - `Data string` Base64-encoded image data. - `MediaType string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `Type BetaManagedAgentsBase64ImageSourceType` - `const BetaManagedAgentsBase64ImageSourceTypeBase64 BetaManagedAgentsBase64ImageSourceType = "base64"` - `type BetaManagedAgentsURLImageSource struct{…}` Image referenced by URL. - `Type BetaManagedAgentsURLImageSourceType` - `const BetaManagedAgentsURLImageSourceTypeURL BetaManagedAgentsURLImageSourceType = "url"` - `URL string` URL of the image to fetch. - `type BetaManagedAgentsFileImageSource struct{…}` Image referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileImageSourceType` - `const BetaManagedAgentsFileImageSourceTypeFile BetaManagedAgentsFileImageSourceType = "file"` - `Type BetaManagedAgentsImageBlockType` - `const BetaManagedAgentsImageBlockTypeImage BetaManagedAgentsImageBlockType = "image"` - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `Source BetaManagedAgentsDocumentBlockSourceUnion` Union type for document source variants. - `type BetaManagedAgentsBase64DocumentSource struct{…}` Base64-encoded document data. - `Data string` Base64-encoded document data. - `MediaType string` MIME type of the document (e.g., "application/pdf"). - `Type BetaManagedAgentsBase64DocumentSourceType` - `const BetaManagedAgentsBase64DocumentSourceTypeBase64 BetaManagedAgentsBase64DocumentSourceType = "base64"` - `type BetaManagedAgentsPlainTextDocumentSource struct{…}` Plain text document content. - `Data string` The plain text content. - `MediaType BetaManagedAgentsPlainTextDocumentSourceMediaType` MIME type of the text content. Must be "text/plain". - `const BetaManagedAgentsPlainTextDocumentSourceMediaTypeTextPlain BetaManagedAgentsPlainTextDocumentSourceMediaType = "text/plain"` - `Type BetaManagedAgentsPlainTextDocumentSourceType` - `const BetaManagedAgentsPlainTextDocumentSourceTypeText BetaManagedAgentsPlainTextDocumentSourceType = "text"` - `type BetaManagedAgentsURLDocumentSource struct{…}` Document referenced by URL. - `Type BetaManagedAgentsURLDocumentSourceType` - `const BetaManagedAgentsURLDocumentSourceTypeURL BetaManagedAgentsURLDocumentSourceType = "url"` - `URL string` URL of the document to fetch. - `type BetaManagedAgentsFileDocumentSource struct{…}` Document referenced by file ID. - `FileID string` ID of a previously uploaded file. - `Type BetaManagedAgentsFileDocumentSourceType` - `const BetaManagedAgentsFileDocumentSourceTypeFile BetaManagedAgentsFileDocumentSourceType = "file"` - `Type BetaManagedAgentsDocumentBlockType` - `const BetaManagedAgentsDocumentBlockTypeDocument BetaManagedAgentsDocumentBlockType = "document"` - `Context string` Additional context about the document for the model. - `Title string` The title of the document. - `Type BetaManagedAgentsUserMessageEventType` - `const BetaManagedAgentsUserMessageEventTypeUserMessage BetaManagedAgentsUserMessageEventType = "user.message"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `type BetaManagedAgentsUserInterruptEvent struct{…}` An interrupt event that pauses agent execution and returns control to the user. - `ID string` Unique identifier for this event. - `Type BetaManagedAgentsUserInterruptEventType` - `const BetaManagedAgentsUserInterruptEventTypeUserInterrupt BetaManagedAgentsUserInterruptEventType = "user.interrupt"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. - `type BetaManagedAgentsUserToolConfirmationEvent struct{…}` A tool confirmation event that approves or denies a pending tool execution. - `ID string` Unique identifier for this event. - `Result BetaManagedAgentsUserToolConfirmationEventResult` UserToolConfirmationResult enum - `const BetaManagedAgentsUserToolConfirmationEventResultAllow BetaManagedAgentsUserToolConfirmationEventResult = "allow"` - `const BetaManagedAgentsUserToolConfirmationEventResultDeny BetaManagedAgentsUserToolConfirmationEventResult = "deny"` - `ToolUseID string` The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserToolConfirmationEventType` - `const BetaManagedAgentsUserToolConfirmationEventTypeUserToolConfirmation BetaManagedAgentsUserToolConfirmationEventType = "user.tool_confirmation"` - `DenyMessage string` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` When set, the confirmation routes to this subagent's thread rather than the primary. Echo this from the `session_thread_id` on the `agent.tool_use` or `agent.mcp_tool_use` event that prompted the approval. - `type BetaManagedAgentsUserCustomToolResultEvent struct{…}` Event sent by the client providing the result of a custom tool execution. - `ID string` Unique identifier for this event. - `CustomToolUseID string` The id of the `agent.custom_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserCustomToolResultEventType` - `const BetaManagedAgentsUserCustomToolResultEventTypeUserCustomToolResult BetaManagedAgentsUserCustomToolResultEventType = "user.custom_tool_result"` - `Content []BetaManagedAgentsUserCustomToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `Citations BetaManagedAgentsSearchResultCitations` Citation settings for a search result. - `Enabled bool` Whether citations are enabled for this search result. - `Content []BetaManagedAgentsSearchResultContent` Array of text content blocks from the search result. - `Text string` The text content. - `Type BetaManagedAgentsSearchResultContentType` - `const BetaManagedAgentsSearchResultContentTypeText BetaManagedAgentsSearchResultContentType = "text"` - `Source string` The URL source of the search result. - `Title string` The title of the search result. - `Type BetaManagedAgentsSearchResultBlockType` - `const BetaManagedAgentsSearchResultBlockTypeSearchResult BetaManagedAgentsSearchResultBlockType = "search_result"` - `IsError bool` Whether the tool execution resulted in an error. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Routes this result to a subagent thread. Copy from the `agent.custom_tool_use` event's `session_thread_id`. - `type BetaManagedAgentsAgentCustomToolUseEvent struct{…}` Event emitted when the agent calls a custom tool. The session goes idle until the client sends a `user.custom_tool_result` event with the result. - `ID string` Unique identifier for this event. - `Input map[string, any]` Input parameters for the tool call. - `Name string` Name of the custom tool being called. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentCustomToolUseEventType` - `const BetaManagedAgentsAgentCustomToolUseEventTypeAgentCustomToolUse BetaManagedAgentsAgentCustomToolUseEventType = "agent.custom_tool_use"` - `SessionThreadID string` When set, this event was cross-posted from a subagent's thread to surface its custom tool use on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.custom_tool_result` event to route the result back. - `type BetaManagedAgentsAgentMessageEvent struct{…}` An agent response event in the session conversation. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsTextBlock` Array of text blocks comprising the agent response. - `Text string` The text content. - `Type BetaManagedAgentsTextBlockType` - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentMessageEventType` - `const BetaManagedAgentsAgentMessageEventTypeAgentMessage BetaManagedAgentsAgentMessageEventType = "agent.message"` - `type BetaManagedAgentsAgentThinkingEvent struct{…}` Indicates the agent is making forward progress via extended thinking. A progress signal, not a content carrier. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentThinkingEventType` - `const BetaManagedAgentsAgentThinkingEventTypeAgentThinking BetaManagedAgentsAgentThinkingEventType = "agent.thinking"` - `type BetaManagedAgentsAgentMCPToolUseEvent struct{…}` Event emitted when the agent invokes a tool provided by an MCP server. - `ID string` Unique identifier for this event. - `Input map[string, any]` Input parameters for the tool call. - `MCPServerName string` Name of the MCP server providing the tool. - `Name string` Name of the MCP tool being used. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentMCPToolUseEventType` - `const BetaManagedAgentsAgentMCPToolUseEventTypeAgentMCPToolUse BetaManagedAgentsAgentMCPToolUseEventType = "agent.mcp_tool_use"` - `EvaluatedPermission BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission` AgentEvaluatedPermission enum - `const BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermissionAllow BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission = "allow"` - `const BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermissionAsk BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission = "ask"` - `const BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermissionDeny BetaManagedAgentsAgentMCPToolUseEventEvaluatedPermission = "deny"` - `SessionThreadID string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `type BetaManagedAgentsAgentMCPToolResultEvent struct{…}` Event representing the result of an MCP tool execution. - `ID string` Unique identifier for this event. - `MCPToolUseID string` The id of the `agent.mcp_tool_use` event this result corresponds to. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentMCPToolResultEventType` - `const BetaManagedAgentsAgentMCPToolResultEventTypeAgentMCPToolResult BetaManagedAgentsAgentMCPToolResultEventType = "agent.mcp_tool_result"` - `Content []BetaManagedAgentsAgentMCPToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `IsError bool` Whether the tool execution resulted in an error. - `type BetaManagedAgentsAgentToolUseEvent struct{…}` Event emitted when the agent invokes a built-in agent tool. - `ID string` Unique identifier for this event. - `Input map[string, any]` Input parameters for the tool call. - `Name string` Name of the agent tool being used. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentToolUseEventType` - `const BetaManagedAgentsAgentToolUseEventTypeAgentToolUse BetaManagedAgentsAgentToolUseEventType = "agent.tool_use"` - `EvaluatedPermission BetaManagedAgentsAgentToolUseEventEvaluatedPermission` AgentEvaluatedPermission enum - `const BetaManagedAgentsAgentToolUseEventEvaluatedPermissionAllow BetaManagedAgentsAgentToolUseEventEvaluatedPermission = "allow"` - `const BetaManagedAgentsAgentToolUseEventEvaluatedPermissionAsk BetaManagedAgentsAgentToolUseEventEvaluatedPermission = "ask"` - `const BetaManagedAgentsAgentToolUseEventEvaluatedPermissionDeny BetaManagedAgentsAgentToolUseEventEvaluatedPermission = "deny"` - `SessionThreadID string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `type BetaManagedAgentsAgentToolResultEvent struct{…}` Event representing the result of an agent tool execution. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `ToolUseID string` The id of the `agent.tool_use` event this result corresponds to. - `Type BetaManagedAgentsAgentToolResultEventType` - `const BetaManagedAgentsAgentToolResultEventTypeAgentToolResult BetaManagedAgentsAgentToolResultEventType = "agent.tool_result"` - `Content []BetaManagedAgentsAgentToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `IsError bool` Whether the tool execution resulted in an error. - `type BetaManagedAgentsAgentThreadMessageReceivedEvent struct{…}` Delivery event written to the target thread's input stream when an agent-to-agent message arrives. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsAgentThreadMessageReceivedEventContentUnion` Message content blocks. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `FromSessionThreadID string` Public `sthr_` ID of the thread that sent the message. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentThreadMessageReceivedEventType` - `const BetaManagedAgentsAgentThreadMessageReceivedEventTypeAgentThreadMessageReceived BetaManagedAgentsAgentThreadMessageReceivedEventType = "agent.thread_message_received"` - `FromAgentName string` Name of the callable agent this message came from. Absent when received from the primary agent. - `type BetaManagedAgentsAgentThreadMessageSentEvent struct{…}` Observability event emitted to the sender's output stream when an agent-to-agent message is sent. - `ID string` Unique identifier for this event. - `Content []BetaManagedAgentsAgentThreadMessageSentEventContentUnion` Message content blocks. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `ProcessedAt Time` A timestamp in RFC 3339 format - `ToSessionThreadID string` Public `sthr_` ID of the thread the message was sent to. - `Type BetaManagedAgentsAgentThreadMessageSentEventType` - `const BetaManagedAgentsAgentThreadMessageSentEventTypeAgentThreadMessageSent BetaManagedAgentsAgentThreadMessageSentEventType = "agent.thread_message_sent"` - `ToAgentName string` Name of the callable agent this message was sent to. Absent when sent to the primary agent. - `type BetaManagedAgentsAgentThreadContextCompactedEvent struct{…}` Indicates that context compaction (summarization) occurred during the session. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsAgentThreadContextCompactedEventType` - `const BetaManagedAgentsAgentThreadContextCompactedEventTypeAgentThreadContextCompacted BetaManagedAgentsAgentThreadContextCompactedEventType = "agent.thread_context_compacted"` - `type BetaManagedAgentsSessionErrorEvent struct{…}` An error event indicating a problem occurred during session execution. - `ID string` Unique identifier for this event. - `Error BetaManagedAgentsSessionErrorEventErrorUnion` An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on `retry_status` and `message` alone. - `type BetaManagedAgentsUnknownError struct{…}` An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on `retry_status` and `message` alone. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsUnknownErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `Type BetaManagedAgentsRetryStatusRetryingType` - `const BetaManagedAgentsRetryStatusRetryingTypeRetrying BetaManagedAgentsRetryStatusRetryingType = "retrying"` - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `Type BetaManagedAgentsRetryStatusExhaustedType` - `const BetaManagedAgentsRetryStatusExhaustedTypeExhausted BetaManagedAgentsRetryStatusExhaustedType = "exhausted"` - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsRetryStatusTerminalType` - `const BetaManagedAgentsRetryStatusTerminalTypeTerminal BetaManagedAgentsRetryStatusTerminalType = "terminal"` - `Type BetaManagedAgentsUnknownErrorType` - `const BetaManagedAgentsUnknownErrorTypeUnknownError BetaManagedAgentsUnknownErrorType = "unknown_error"` - `type BetaManagedAgentsModelOverloadedError struct{…}` The model is currently overloaded. Emitted after automatic retries are exhausted. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsModelOverloadedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsModelOverloadedErrorType` - `const BetaManagedAgentsModelOverloadedErrorTypeModelOverloadedError BetaManagedAgentsModelOverloadedErrorType = "model_overloaded_error"` - `type BetaManagedAgentsModelRateLimitedError struct{…}` The model request was rate-limited. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsModelRateLimitedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsModelRateLimitedErrorType` - `const BetaManagedAgentsModelRateLimitedErrorTypeModelRateLimitedError BetaManagedAgentsModelRateLimitedErrorType = "model_rate_limited_error"` - `type BetaManagedAgentsModelRequestFailedError struct{…}` A model request failed for a reason other than overload or rate-limiting. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsModelRequestFailedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsModelRequestFailedErrorType` - `const BetaManagedAgentsModelRequestFailedErrorTypeModelRequestFailedError BetaManagedAgentsModelRequestFailedErrorType = "model_request_failed_error"` - `type BetaManagedAgentsMCPConnectionFailedError struct{…}` Failed to connect to an MCP server. - `MCPServerName string` Name of the MCP server that failed to connect. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsMCPConnectionFailedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsMCPConnectionFailedErrorType` - `const BetaManagedAgentsMCPConnectionFailedErrorTypeMCPConnectionFailedError BetaManagedAgentsMCPConnectionFailedErrorType = "mcp_connection_failed_error"` - `type BetaManagedAgentsMCPAuthenticationFailedError struct{…}` Authentication to an MCP server failed. - `MCPServerName string` Name of the MCP server that failed authentication. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsMCPAuthenticationFailedErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsMCPAuthenticationFailedErrorType` - `const BetaManagedAgentsMCPAuthenticationFailedErrorTypeMCPAuthenticationFailedError BetaManagedAgentsMCPAuthenticationFailedErrorType = "mcp_authentication_failed_error"` - `type BetaManagedAgentsBillingError struct{…}` The caller's organization or workspace cannot make model requests — out of credits or spend limit reached. Retrying with the same credentials will not succeed; the caller must resolve the billing state. - `Message string` Human-readable error description. - `RetryStatus BetaManagedAgentsBillingErrorRetryStatusUnion` What the client should do next in response to this error. - `type BetaManagedAgentsRetryStatusRetrying struct{…}` The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. - `type BetaManagedAgentsRetryStatusExhausted struct{…}` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type BetaManagedAgentsRetryStatusTerminal struct{…}` The session encountered a terminal error and will transition to `terminated` state. - `Type BetaManagedAgentsBillingErrorType` - `const BetaManagedAgentsBillingErrorTypeBillingError BetaManagedAgentsBillingErrorType = "billing_error"` - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionErrorEventType` - `const BetaManagedAgentsSessionErrorEventTypeSessionError BetaManagedAgentsSessionErrorEventType = "session.error"` - `type BetaManagedAgentsSessionStatusRescheduledEvent struct{…}` Indicates the session is recovering from an error state and is rescheduled for execution. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionStatusRescheduledEventType` - `const BetaManagedAgentsSessionStatusRescheduledEventTypeSessionStatusRescheduled BetaManagedAgentsSessionStatusRescheduledEventType = "session.status_rescheduled"` - `type BetaManagedAgentsSessionStatusRunningEvent struct{…}` Indicates the session is actively running and the agent is working. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionStatusRunningEventType` - `const BetaManagedAgentsSessionStatusRunningEventTypeSessionStatusRunning BetaManagedAgentsSessionStatusRunningEventType = "session.status_running"` - `type BetaManagedAgentsSessionStatusIdleEvent struct{…}` Indicates the agent has paused and is awaiting user input. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `StopReason BetaManagedAgentsSessionStatusIdleEventStopReasonUnion` The agent completed its turn naturally and is ready for the next user message. - `type BetaManagedAgentsSessionEndTurn struct{…}` The agent completed its turn naturally and is ready for the next user message. - `Type BetaManagedAgentsSessionEndTurnType` - `const BetaManagedAgentsSessionEndTurnTypeEndTurn BetaManagedAgentsSessionEndTurnType = "end_turn"` - `type BetaManagedAgentsSessionRequiresAction struct{…}` The agent is idle waiting on one or more blocking user-input events (tool confirmation, custom tool result, etc.). Resolving all of them transitions the session back to running. - `EventIDs []string` The ids of events the agent is blocked on. Resolving fewer than all re-emits `session.status_idle` with the remainder. - `Type BetaManagedAgentsSessionRequiresActionType` - `const BetaManagedAgentsSessionRequiresActionTypeRequiresAction BetaManagedAgentsSessionRequiresActionType = "requires_action"` - `type BetaManagedAgentsSessionRetriesExhausted struct{…}` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `Type BetaManagedAgentsSessionRetriesExhaustedType` - `const BetaManagedAgentsSessionRetriesExhaustedTypeRetriesExhausted BetaManagedAgentsSessionRetriesExhaustedType = "retries_exhausted"` - `Type BetaManagedAgentsSessionStatusIdleEventType` - `const BetaManagedAgentsSessionStatusIdleEventTypeSessionStatusIdle BetaManagedAgentsSessionStatusIdleEventType = "session.status_idle"` - `type BetaManagedAgentsSessionStatusTerminatedEvent struct{…}` Indicates the session has terminated, either due to an error or completion. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionStatusTerminatedEventType` - `const BetaManagedAgentsSessionStatusTerminatedEventTypeSessionStatusTerminated BetaManagedAgentsSessionStatusTerminatedEventType = "session.status_terminated"` - `type BetaManagedAgentsSessionThreadCreatedEvent struct{…}` Emitted when a subagent is spawned as a new thread. Written to the parent thread's output stream so clients observing the session see child creation. - `ID string` Unique identifier for this event. - `AgentName string` Name of the callable agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public `sthr_` ID of the newly created thread. - `Type BetaManagedAgentsSessionThreadCreatedEventType` - `const BetaManagedAgentsSessionThreadCreatedEventTypeSessionThreadCreated BetaManagedAgentsSessionThreadCreatedEventType = "session.thread_created"` - `type BetaManagedAgentsSpanOutcomeEvaluationStartEvent struct{…}` Emitted when an outcome evaluation cycle begins. - `ID string` Unique identifier for this event. - `Iteration int64` 0-indexed revision cycle. 0 is the first evaluation; 1 is the re-evaluation after the first revision; etc. - `OutcomeID string` The `outc_` ID of the outcome being evaluated. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanOutcomeEvaluationStartEventType` - `const BetaManagedAgentsSpanOutcomeEvaluationStartEventTypeSpanOutcomeEvaluationStart BetaManagedAgentsSpanOutcomeEvaluationStartEventType = "span.outcome_evaluation_start"` - `type BetaManagedAgentsSpanOutcomeEvaluationEndEvent struct{…}` Emitted when an outcome evaluation cycle completes. Carries the verdict and aggregate token usage. A verdict of `needs_revision` means another evaluation cycle follows; `satisfied`, `max_iterations_reached`, `failed`, or `interrupted` are terminal — no further evaluation cycles follow. - `ID string` Unique identifier for this event. - `Explanation string` Human-readable explanation of the verdict. For `needs_revision`, describes which criteria failed and why. - `Iteration int64` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `OutcomeEvaluationStartID string` The id of the corresponding `span.outcome_evaluation_start` event. - `OutcomeID string` The `outc_` ID of the outcome being evaluated. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Result string` Evaluation verdict. 'satisfied': criteria met, session goes idle. 'needs_revision': criteria not met, another revision cycle follows. 'max_iterations_reached': evaluation budget exhausted with criteria still unmet — one final acknowledgment turn follows before the session goes idle, but no further evaluation runs. 'failed': grader determined the rubric does not apply to the deliverables. 'interrupted': user sent an interrupt while evaluation was in progress. - `Type BetaManagedAgentsSpanOutcomeEvaluationEndEventType` - `const BetaManagedAgentsSpanOutcomeEvaluationEndEventTypeSpanOutcomeEvaluationEnd BetaManagedAgentsSpanOutcomeEvaluationEndEventType = "span.outcome_evaluation_end"` - `Usage BetaManagedAgentsSpanModelUsage` Token usage for a single model request. - `CacheCreationInputTokens int64` Tokens used to create prompt cache in this request. - `CacheReadInputTokens int64` Tokens read from prompt cache in this request. - `InputTokens int64` Input tokens consumed by this request. - `OutputTokens int64` Output tokens generated by this request. - `Speed BetaManagedAgentsSpanModelUsageSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsSpanModelUsageSpeedStandard BetaManagedAgentsSpanModelUsageSpeed = "standard"` - `const BetaManagedAgentsSpanModelUsageSpeedFast BetaManagedAgentsSpanModelUsageSpeed = "fast"` - `type BetaManagedAgentsSpanModelRequestStartEvent struct{…}` Emitted when a model request is initiated by the agent. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanModelRequestStartEventType` - `const BetaManagedAgentsSpanModelRequestStartEventTypeSpanModelRequestStart BetaManagedAgentsSpanModelRequestStartEventType = "span.model_request_start"` - `type BetaManagedAgentsSpanModelRequestEndEvent struct{…}` Emitted when a model request completes. - `ID string` Unique identifier for this event. - `IsError bool` Whether the model request resulted in an error. - `ModelRequestStartID string` The id of the corresponding `span.model_request_start` event. - `ModelUsage BetaManagedAgentsSpanModelUsage` Token usage for a single model request. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanModelRequestEndEventType` - `const BetaManagedAgentsSpanModelRequestEndEventTypeSpanModelRequestEnd BetaManagedAgentsSpanModelRequestEndEventType = "span.model_request_end"` - `type BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent struct{…}` Periodic heartbeat emitted while an outcome evaluation cycle is in progress. Distinguishes 'evaluation is actively running' from 'evaluation is stuck' between the corresponding `span.outcome_evaluation_start` and `span.outcome_evaluation_end` events. - `ID string` Unique identifier for this event. - `Iteration int64` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `OutcomeID string` The `outc_` ID of the outcome being evaluated. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSpanOutcomeEvaluationOngoingEventType` - `const BetaManagedAgentsSpanOutcomeEvaluationOngoingEventTypeSpanOutcomeEvaluationOngoing BetaManagedAgentsSpanOutcomeEvaluationOngoingEventType = "span.outcome_evaluation_ongoing"` - `type BetaManagedAgentsUserDefineOutcomeEvent struct{…}` Echo of a `user.define_outcome` input event. Carries the server-generated `outcome_id` that subsequent `span.outcome_evaluation_*` events reference. - `ID string` Unique identifier for this event. - `Description string` What the agent should produce. Copied from the input event. - `MaxIterations int64` Evaluate-then-revise cycles before giving up. Default 3, max 20. - `OutcomeID string` Server-generated `outc_` ID for this outcome. Referenced by `span.outcome_evaluation_*` events and the session's `outcome_evaluations` list. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Rubric BetaManagedAgentsUserDefineOutcomeEventRubricUnion` Rubric for grading the quality of an outcome. - `type BetaManagedAgentsFileRubric struct{…}` Rubric referenced by a file uploaded via the Files API. - `FileID string` ID of the rubric file. - `Type BetaManagedAgentsFileRubricType` - `const BetaManagedAgentsFileRubricTypeFile BetaManagedAgentsFileRubricType = "file"` - `type BetaManagedAgentsTextRubric struct{…}` Rubric content provided inline as text. - `Content string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `Type BetaManagedAgentsTextRubricType` - `const BetaManagedAgentsTextRubricTypeText BetaManagedAgentsTextRubricType = "text"` - `Type BetaManagedAgentsUserDefineOutcomeEventType` - `const BetaManagedAgentsUserDefineOutcomeEventTypeUserDefineOutcome BetaManagedAgentsUserDefineOutcomeEventType = "user.define_outcome"` - `type BetaManagedAgentsSessionDeletedEvent struct{…}` Emitted when a session has been deleted. Terminates any active event stream — no further events will be emitted for this session. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionDeletedEventType` - `const BetaManagedAgentsSessionDeletedEventTypeSessionDeleted BetaManagedAgentsSessionDeletedEventType = "session.deleted"` - `type BetaManagedAgentsSessionThreadStatusRunningEvent struct{…}` A session thread has begun executing. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that started running. - `Type BetaManagedAgentsSessionThreadStatusRunningEventType` - `const BetaManagedAgentsSessionThreadStatusRunningEventTypeSessionThreadStatusRunning BetaManagedAgentsSessionThreadStatusRunningEventType = "session.thread_status_running"` - `type BetaManagedAgentsSessionThreadStatusIdleEvent struct{…}` A session thread has yielded and is awaiting input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that went idle. - `StopReason BetaManagedAgentsSessionThreadStatusIdleEventStopReasonUnion` The agent completed its turn naturally and is ready for the next user message. - `type BetaManagedAgentsSessionEndTurn struct{…}` The agent completed its turn naturally and is ready for the next user message. - `type BetaManagedAgentsSessionRequiresAction struct{…}` The agent is idle waiting on one or more blocking user-input events (tool confirmation, custom tool result, etc.). Resolving all of them transitions the session back to running. - `type BetaManagedAgentsSessionRetriesExhausted struct{…}` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `Type BetaManagedAgentsSessionThreadStatusIdleEventType` - `const BetaManagedAgentsSessionThreadStatusIdleEventTypeSessionThreadStatusIdle BetaManagedAgentsSessionThreadStatusIdleEventType = "session.thread_status_idle"` - `type BetaManagedAgentsSessionThreadStatusTerminatedEvent struct{…}` A session thread has terminated and will accept no further input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that terminated. - `Type BetaManagedAgentsSessionThreadStatusTerminatedEventType` - `const BetaManagedAgentsSessionThreadStatusTerminatedEventTypeSessionThreadStatusTerminated BetaManagedAgentsSessionThreadStatusTerminatedEventType = "session.thread_status_terminated"` - `type BetaManagedAgentsUserToolResultEvent struct{…}` Event sent by the client providing the result of an agent-toolset tool execution. Only valid on `self_hosted` environments, where sandbox-routed tools are executed by the client rather than the server. - `ID string` Unique identifier for this event. - `ToolUseID string` The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `Type BetaManagedAgentsUserToolResultEventType` - `const BetaManagedAgentsUserToolResultEventTypeUserToolResult BetaManagedAgentsUserToolResultEventType = "user.tool_result"` - `Content []BetaManagedAgentsUserToolResultEventContentUnion` The result content returned by the tool. - `type BetaManagedAgentsTextBlock struct{…}` Regular text content. - `type BetaManagedAgentsImageBlock struct{…}` Image content specified directly as base64 data or as a reference via a URL. - `type BetaManagedAgentsDocumentBlock struct{…}` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type BetaManagedAgentsSearchResultBlock struct{…}` A block containing a web search result. - `IsError bool` Whether the tool execution resulted in an error. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Routes this result to a subagent thread. Copy from the `agent.tool_use` event's `session_thread_id`. - `type BetaManagedAgentsSessionThreadStatusRescheduledEvent struct{…}` A session thread hit a transient error and is retrying automatically. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `ID string` Unique identifier for this event. - `AgentName string` Name of the agent the thread runs. - `ProcessedAt Time` A timestamp in RFC 3339 format - `SessionThreadID string` Public sthr_ ID of the thread that is retrying. - `Type BetaManagedAgentsSessionThreadStatusRescheduledEventType` - `const BetaManagedAgentsSessionThreadStatusRescheduledEventTypeSessionThreadStatusRescheduled BetaManagedAgentsSessionThreadStatusRescheduledEventType = "session.thread_status_rescheduled"` - `type BetaManagedAgentsSessionUpdatedEvent struct{…}` Emitted when an UpdateSession request changed at least one field. Carries only the fields that changed; absent fields were not part of the update. The new configuration applies from the next turn. - `ID string` Unique identifier for this event. - `ProcessedAt Time` A timestamp in RFC 3339 format - `Type BetaManagedAgentsSessionUpdatedEventType` - `const BetaManagedAgentsSessionUpdatedEventTypeSessionUpdated BetaManagedAgentsSessionUpdatedEventType = "session.updated"` - `Agent BetaManagedAgentsSessionAgent` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `const BetaManagedAgentsMCPServerURLDefinitionTypeURL BetaManagedAgentsMCPServerURLDefinitionType = "url"` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `ID BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `type BetaManagedAgentsModel string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const BetaManagedAgentsModelClaudeOpus4_8 BetaManagedAgentsModel = "claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_7 BetaManagedAgentsModel = "claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `const BetaManagedAgentsModelClaudeOpus4_6 BetaManagedAgentsModel = "claude-opus-4-6"` Most intelligent model for building agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_6 BetaManagedAgentsModel = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5 BetaManagedAgentsModel = "claude-haiku-4-5"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeHaiku4_5_20251001 BetaManagedAgentsModel = "claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `const BetaManagedAgentsModelClaudeOpus4_5 BetaManagedAgentsModel = "claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeOpus4_5_20251101 BetaManagedAgentsModel = "claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `const BetaManagedAgentsModelClaudeSonnet4_5 BetaManagedAgentsModel = "claude-sonnet-4-5"` High-performance model for agents and coding - `const BetaManagedAgentsModelClaudeSonnet4_5_20250929 BetaManagedAgentsModel = "claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `string` - `Speed BetaManagedAgentsModelConfigSpeed` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaManagedAgentsModelConfigSpeedStandard BetaManagedAgentsModelConfigSpeed = "standard"` - `const BetaManagedAgentsModelConfigSpeedFast BetaManagedAgentsModelConfigSpeed = "fast"` - `Multiagent BetaManagedAgentsSessionMultiagentCoordinator` Resolved coordinator topology with full agent definitions for each roster member. - `Agents []BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `ID string` - `Description string` - `MCPServers []BetaManagedAgentsMCPServerURLDefinition` - `Name string` - `Type BetaManagedAgentsMCPServerURLDefinitionType` - `URL string` - `Model BetaManagedAgentsModelConfig` Model identifier and configuration. - `Name string` - `Skills []BetaManagedAgentsSessionThreadAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `SkillID string` - `Type BetaManagedAgentsAnthropicSkillType` - `const BetaManagedAgentsAnthropicSkillTypeAnthropic BetaManagedAgentsAnthropicSkillType = "anthropic"` - `Version string` - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `SkillID string` - `Type BetaManagedAgentsCustomSkillType` - `const BetaManagedAgentsCustomSkillTypeCustom BetaManagedAgentsCustomSkillType = "custom"` - `Version string` - `System string` - `Tools []BetaManagedAgentsSessionThreadAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `Configs []BetaManagedAgentsAgentToolConfig` - `Enabled bool` - `Name BetaManagedAgentsAgentToolConfigName` Built-in agent tool identifier. - `const BetaManagedAgentsAgentToolConfigNameBash BetaManagedAgentsAgentToolConfigName = "bash"` - `const BetaManagedAgentsAgentToolConfigNameEdit BetaManagedAgentsAgentToolConfigName = "edit"` - `const BetaManagedAgentsAgentToolConfigNameRead BetaManagedAgentsAgentToolConfigName = "read"` - `const BetaManagedAgentsAgentToolConfigNameWrite BetaManagedAgentsAgentToolConfigName = "write"` - `const BetaManagedAgentsAgentToolConfigNameGlob BetaManagedAgentsAgentToolConfigName = "glob"` - `const BetaManagedAgentsAgentToolConfigNameGrep BetaManagedAgentsAgentToolConfigName = "grep"` - `const BetaManagedAgentsAgentToolConfigNameWebFetch BetaManagedAgentsAgentToolConfigName = "web_fetch"` - `const BetaManagedAgentsAgentToolConfigNameWebSearch BetaManagedAgentsAgentToolConfigName = "web_search"` - `PermissionPolicy BetaManagedAgentsAgentToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `Type BetaManagedAgentsAlwaysAllowPolicyType` - `const BetaManagedAgentsAlwaysAllowPolicyTypeAlwaysAllow BetaManagedAgentsAlwaysAllowPolicyType = "always_allow"` - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAlwaysAskPolicyType` - `const BetaManagedAgentsAlwaysAskPolicyTypeAlwaysAsk BetaManagedAgentsAlwaysAskPolicyType = "always_ask"` - `DefaultConfig BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `Type BetaManagedAgentsAgentToolset20260401Type` - `const BetaManagedAgentsAgentToolset20260401TypeAgentToolset20260401 BetaManagedAgentsAgentToolset20260401Type = "agent_toolset_20260401"` - `type BetaManagedAgentsMCPToolset struct{…}` - `Configs []BetaManagedAgentsMCPToolConfig` - `Enabled bool` - `Name string` - `PermissionPolicy BetaManagedAgentsMCPToolConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `DefaultConfig BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `Enabled bool` - `PermissionPolicy BetaManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` Permission policy for tool execution. - `type BetaManagedAgentsAlwaysAllowPolicy struct{…}` Tool calls are automatically approved without user confirmation. - `type BetaManagedAgentsAlwaysAskPolicy struct{…}` Tool calls require user confirmation before execution. - `MCPServerName string` - `Type BetaManagedAgentsMCPToolsetType` - `const BetaManagedAgentsMCPToolsetTypeMCPToolset BetaManagedAgentsMCPToolsetType = "mcp_toolset"` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Description string` - `InputSchema BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `Properties map[string, any]` JSON Schema properties defining the tool's input parameters. - `Required []string` List of required property names. - `Type BetaManagedAgentsCustomToolInputSchemaType` Must be 'object' for tool input schemas. - `const BetaManagedAgentsCustomToolInputSchemaTypeObject BetaManagedAgentsCustomToolInputSchemaType = "object"` - `Name string` - `Type BetaManagedAgentsCustomToolType` - `const BetaManagedAgentsCustomToolTypeCustom BetaManagedAgentsCustomToolType = "custom"` - `Type BetaManagedAgentsSessionThreadAgentType` - `const BetaManagedAgentsSessionThreadAgentTypeAgent BetaManagedAgentsSessionThreadAgentType = "agent"` - `Version int64` - `Type BetaManagedAgentsSessionMultiagentCoordinatorType` - `const BetaManagedAgentsSessionMultiagentCoordinatorTypeCoordinator BetaManagedAgentsSessionMultiagentCoordinatorType = "coordinator"` - `Name string` - `Skills []BetaManagedAgentsSessionAgentSkillUnion` - `type BetaManagedAgentsAnthropicSkill struct{…}` A resolved Anthropic-managed skill. - `type BetaManagedAgentsCustomSkill struct{…}` A resolved user-created custom skill. - `System string` - `Tools []BetaManagedAgentsSessionAgentToolUnion` - `type BetaManagedAgentsAgentToolset20260401 struct{…}` - `type BetaManagedAgentsMCPToolset struct{…}` - `type BetaManagedAgentsCustomTool struct{…}` A custom tool as returned in API responses. - `Type BetaManagedAgentsSessionAgentType` - `const BetaManagedAgentsSessionAgentTypeAgent BetaManagedAgentsSessionAgentType = "agent"` - `Version int64` - `Metadata map[string, string]` The session's full metadata bag after the update. Present when the update set non-empty metadata; absent when metadata was unchanged or cleared to empty. - `Title string` The session's new title. Present only when the update changed it. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) stream := client.Beta.Sessions.Threads.Events.StreamEvents( context.TODO(), "sthr_011CZkZVWa6oIjw0rgXZpnBt", anthropic.BetaSessionThreadEventStreamParams{ SessionID: "sesn_011CZkZAtmR3yMPDzynEDxu7", }, ) for stream.Next() { fmt.Printf("%+v\n", stream.Current()) } err := stream.Err() if err != nil { panic(err.Error()) } } ``` #### Response ```json { "id": "sevt_011CZkZGOp0iBcp4kaQSihUmy", "content": [ { "text": "Where is my order #1234?", "type": "text" } ], "type": "user.message", "processed_at": "2026-03-15T10:00:00Z" } ``` # Vaults ## Create Vault `client.Beta.Vaults.New(ctx, params) (*BetaManagedAgentsVault, error)` **post** `/v1/vaults` Create Vault ### Parameters - `params BetaVaultNewParams` - `DisplayName param.Field[string]` Body param: Human-readable name for the vault. 1-255 characters. - `Metadata param.Field[map[string, string]]` Body param: Arbitrary key-value metadata to attach to the vault. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsVault struct{…}` A vault that stores credentials for use by agents during sessions. - `ID string` Unique identifier for the vault. - `ArchivedAt Time` A timestamp in RFC 3339 format - `CreatedAt Time` A timestamp in RFC 3339 format - `DisplayName string` Human-readable name for the vault. - `Metadata map[string, string]` Arbitrary key-value metadata attached to the vault. - `Type BetaManagedAgentsVaultType` - `const BetaManagedAgentsVaultTypeVault BetaManagedAgentsVaultType = "vault"` - `UpdatedAt Time` A timestamp in RFC 3339 format ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsVault, err := client.Beta.Vaults.New(context.TODO(), anthropic.BetaVaultNewParams{ DisplayName: "Example vault", }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsVault.ID) } ``` #### Response ```json { "id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "display_name": "Example vault", "metadata": { "environment": "production" }, "type": "vault", "updated_at": "2026-03-15T10:00:00Z" } ``` ## List Vaults `client.Beta.Vaults.List(ctx, params) (*PageCursor[BetaManagedAgentsVault], error)` **get** `/v1/vaults` List Vaults ### Parameters - `params BetaVaultListParams` - `IncludeArchived param.Field[bool]` Query param: Whether to include archived vaults in the results. - `Limit param.Field[int64]` Query param: Maximum number of vaults to return per page. Defaults to 20, maximum 100. - `Page param.Field[string]` Query param: Opaque pagination token from a previous `list_vaults` response. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsVault struct{…}` A vault that stores credentials for use by agents during sessions. - `ID string` Unique identifier for the vault. - `ArchivedAt Time` A timestamp in RFC 3339 format - `CreatedAt Time` A timestamp in RFC 3339 format - `DisplayName string` Human-readable name for the vault. - `Metadata map[string, string]` Arbitrary key-value metadata attached to the vault. - `Type BetaManagedAgentsVaultType` - `const BetaManagedAgentsVaultTypeVault BetaManagedAgentsVaultType = "vault"` - `UpdatedAt Time` A timestamp in RFC 3339 format ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) page, err := client.Beta.Vaults.List(context.TODO(), anthropic.BetaVaultListParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "data": [ { "id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "display_name": "Example vault", "metadata": { "environment": "production" }, "type": "vault", "updated_at": "2026-03-15T10:00:00Z" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ## Get Vault `client.Beta.Vaults.Get(ctx, vaultID, query) (*BetaManagedAgentsVault, error)` **get** `/v1/vaults/{vault_id}` Get Vault ### Parameters - `vaultID string` - `query BetaVaultGetParams` - `Betas param.Field[[]AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsVault struct{…}` A vault that stores credentials for use by agents during sessions. - `ID string` Unique identifier for the vault. - `ArchivedAt Time` A timestamp in RFC 3339 format - `CreatedAt Time` A timestamp in RFC 3339 format - `DisplayName string` Human-readable name for the vault. - `Metadata map[string, string]` Arbitrary key-value metadata attached to the vault. - `Type BetaManagedAgentsVaultType` - `const BetaManagedAgentsVaultTypeVault BetaManagedAgentsVaultType = "vault"` - `UpdatedAt Time` A timestamp in RFC 3339 format ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsVault, err := client.Beta.Vaults.Get( context.TODO(), "vlt_011CZkZDLs7fYzm1hXNPeRjv", anthropic.BetaVaultGetParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsVault.ID) } ``` #### Response ```json { "id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "display_name": "Example vault", "metadata": { "environment": "production" }, "type": "vault", "updated_at": "2026-03-15T10:00:00Z" } ``` ## Update Vault `client.Beta.Vaults.Update(ctx, vaultID, params) (*BetaManagedAgentsVault, error)` **post** `/v1/vaults/{vault_id}` Update Vault ### Parameters - `vaultID string` - `params BetaVaultUpdateParams` - `DisplayName param.Field[string]` Body param: Updated human-readable name for the vault. 1-255 characters. - `Metadata param.Field[map[string, string]]` Body param: Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omitted keys are preserved. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsVault struct{…}` A vault that stores credentials for use by agents during sessions. - `ID string` Unique identifier for the vault. - `ArchivedAt Time` A timestamp in RFC 3339 format - `CreatedAt Time` A timestamp in RFC 3339 format - `DisplayName string` Human-readable name for the vault. - `Metadata map[string, string]` Arbitrary key-value metadata attached to the vault. - `Type BetaManagedAgentsVaultType` - `const BetaManagedAgentsVaultTypeVault BetaManagedAgentsVaultType = "vault"` - `UpdatedAt Time` A timestamp in RFC 3339 format ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsVault, err := client.Beta.Vaults.Update( context.TODO(), "vlt_011CZkZDLs7fYzm1hXNPeRjv", anthropic.BetaVaultUpdateParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsVault.ID) } ``` #### Response ```json { "id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "display_name": "Example vault", "metadata": { "environment": "production" }, "type": "vault", "updated_at": "2026-03-15T10:00:00Z" } ``` ## Delete Vault `client.Beta.Vaults.Delete(ctx, vaultID, body) (*BetaManagedAgentsDeletedVault, error)` **delete** `/v1/vaults/{vault_id}` Delete Vault ### Parameters - `vaultID string` - `body BetaVaultDeleteParams` - `Betas param.Field[[]AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsDeletedVault struct{…}` Confirmation of a deleted vault. - `ID string` Unique identifier of the deleted vault. - `Type BetaManagedAgentsDeletedVaultType` - `const BetaManagedAgentsDeletedVaultTypeVaultDeleted BetaManagedAgentsDeletedVaultType = "vault_deleted"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsDeletedVault, err := client.Beta.Vaults.Delete( context.TODO(), "vlt_011CZkZDLs7fYzm1hXNPeRjv", anthropic.BetaVaultDeleteParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsDeletedVault.ID) } ``` #### Response ```json { "id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "type": "vault_deleted" } ``` ## Archive Vault `client.Beta.Vaults.Archive(ctx, vaultID, body) (*BetaManagedAgentsVault, error)` **post** `/v1/vaults/{vault_id}/archive` Archive Vault ### Parameters - `vaultID string` - `body BetaVaultArchiveParams` - `Betas param.Field[[]AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsVault struct{…}` A vault that stores credentials for use by agents during sessions. - `ID string` Unique identifier for the vault. - `ArchivedAt Time` A timestamp in RFC 3339 format - `CreatedAt Time` A timestamp in RFC 3339 format - `DisplayName string` Human-readable name for the vault. - `Metadata map[string, string]` Arbitrary key-value metadata attached to the vault. - `Type BetaManagedAgentsVaultType` - `const BetaManagedAgentsVaultTypeVault BetaManagedAgentsVaultType = "vault"` - `UpdatedAt Time` A timestamp in RFC 3339 format ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsVault, err := client.Beta.Vaults.Archive( context.TODO(), "vlt_011CZkZDLs7fYzm1hXNPeRjv", anthropic.BetaVaultArchiveParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsVault.ID) } ``` #### Response ```json { "id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "display_name": "Example vault", "metadata": { "environment": "production" }, "type": "vault", "updated_at": "2026-03-15T10:00:00Z" } ``` ## Domain Types ### Beta Managed Agents Deleted Vault - `type BetaManagedAgentsDeletedVault struct{…}` Confirmation of a deleted vault. - `ID string` Unique identifier of the deleted vault. - `Type BetaManagedAgentsDeletedVaultType` - `const BetaManagedAgentsDeletedVaultTypeVaultDeleted BetaManagedAgentsDeletedVaultType = "vault_deleted"` ### Beta Managed Agents Vault - `type BetaManagedAgentsVault struct{…}` A vault that stores credentials for use by agents during sessions. - `ID string` Unique identifier for the vault. - `ArchivedAt Time` A timestamp in RFC 3339 format - `CreatedAt Time` A timestamp in RFC 3339 format - `DisplayName string` Human-readable name for the vault. - `Metadata map[string, string]` Arbitrary key-value metadata attached to the vault. - `Type BetaManagedAgentsVaultType` - `const BetaManagedAgentsVaultTypeVault BetaManagedAgentsVaultType = "vault"` - `UpdatedAt Time` A timestamp in RFC 3339 format # Credentials ## Create Credential `client.Beta.Vaults.Credentials.New(ctx, vaultID, params) (*BetaManagedAgentsCredential, error)` **post** `/v1/vaults/{vault_id}/credentials` Create Credential ### Parameters - `vaultID string` - `params BetaVaultCredentialNewParams` - `Auth param.Field[BetaVaultCredentialNewParamsAuthUnion]` Body param: Authentication details for creating a credential. - `type BetaManagedAgentsMCPOAuthCreateParamsResp struct{…}` Parameters for creating an MCP OAuth credential. - `AccessToken string` OAuth access token. - `MCPServerURL string` URL of the MCP server this credential authenticates against. - `Type BetaManagedAgentsMCPOAuthCreateParamsType` - `const BetaManagedAgentsMCPOAuthCreateParamsTypeMCPOAuth BetaManagedAgentsMCPOAuthCreateParamsType = "mcp_oauth"` - `ExpiresAt Time` A timestamp in RFC 3339 format - `Refresh BetaManagedAgentsMCPOAuthRefreshParamsResp` OAuth refresh token parameters for creating a credential with refresh support. - `ClientID string` OAuth client ID. - `RefreshToken string` OAuth refresh token. - `TokenEndpoint string` Token endpoint URL used to refresh the access token. - `TokenEndpointAuth BetaManagedAgentsMCPOAuthRefreshParamsTokenEndpointAuthUnionResp` Token endpoint requires no client authentication. - `type BetaManagedAgentsTokenEndpointAuthNoneParamResp struct{…}` Token endpoint requires no client authentication. - `Type BetaManagedAgentsTokenEndpointAuthNoneParamType` - `const BetaManagedAgentsTokenEndpointAuthNoneParamTypeNone BetaManagedAgentsTokenEndpointAuthNoneParamType = "none"` - `type BetaManagedAgentsTokenEndpointAuthBasicParamResp struct{…}` Token endpoint uses HTTP Basic authentication with client credentials. - `ClientSecret string` OAuth client secret. - `Type BetaManagedAgentsTokenEndpointAuthBasicParamType` - `const BetaManagedAgentsTokenEndpointAuthBasicParamTypeClientSecretBasic BetaManagedAgentsTokenEndpointAuthBasicParamType = "client_secret_basic"` - `type BetaManagedAgentsTokenEndpointAuthPostParamResp struct{…}` Token endpoint uses POST body authentication with client credentials. - `ClientSecret string` OAuth client secret. - `Type BetaManagedAgentsTokenEndpointAuthPostParamType` - `const BetaManagedAgentsTokenEndpointAuthPostParamTypeClientSecretPost BetaManagedAgentsTokenEndpointAuthPostParamType = "client_secret_post"` - `Resource string` OAuth resource indicator. - `Scope string` OAuth scope for the refresh request. - `type BetaManagedAgentsStaticBearerCreateParamsResp struct{…}` Parameters for creating a static bearer token credential. - `Token string` Static bearer token value. - `MCPServerURL string` URL of the MCP server this credential authenticates against. - `Type BetaManagedAgentsStaticBearerCreateParamsType` - `const BetaManagedAgentsStaticBearerCreateParamsTypeStaticBearer BetaManagedAgentsStaticBearerCreateParamsType = "static_bearer"` - `DisplayName param.Field[string]` Body param: Human-readable name for the credential. Up to 255 characters. - `Metadata param.Field[map[string, string]]` Body param: Arbitrary key-value metadata to attach to the credential. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsCredential struct{…}` A credential stored in a vault. Sensitive fields are never returned in responses. - `ID string` Unique identifier for the credential. - `ArchivedAt Time` A timestamp in RFC 3339 format - `Auth BetaManagedAgentsCredentialAuthUnion` Authentication details for a credential. - `type BetaManagedAgentsMCPOAuthAuthResponse struct{…}` OAuth credential details for an MCP server. - `MCPServerURL string` URL of the MCP server this credential authenticates against. - `Type BetaManagedAgentsMCPOAuthAuthResponseType` - `const BetaManagedAgentsMCPOAuthAuthResponseTypeMCPOAuth BetaManagedAgentsMCPOAuthAuthResponseType = "mcp_oauth"` - `ExpiresAt Time` A timestamp in RFC 3339 format - `Refresh BetaManagedAgentsMCPOAuthRefreshResponse` OAuth refresh token configuration returned in credential responses. - `ClientID string` OAuth client ID. - `TokenEndpoint string` Token endpoint URL used to refresh the access token. - `TokenEndpointAuth BetaManagedAgentsMCPOAuthRefreshResponseTokenEndpointAuthUnion` Token endpoint requires no client authentication. - `type BetaManagedAgentsTokenEndpointAuthNoneResponse struct{…}` Token endpoint requires no client authentication. - `Type BetaManagedAgentsTokenEndpointAuthNoneResponseType` - `const BetaManagedAgentsTokenEndpointAuthNoneResponseTypeNone BetaManagedAgentsTokenEndpointAuthNoneResponseType = "none"` - `type BetaManagedAgentsTokenEndpointAuthBasicResponse struct{…}` Token endpoint uses HTTP Basic authentication with client credentials. - `Type BetaManagedAgentsTokenEndpointAuthBasicResponseType` - `const BetaManagedAgentsTokenEndpointAuthBasicResponseTypeClientSecretBasic BetaManagedAgentsTokenEndpointAuthBasicResponseType = "client_secret_basic"` - `type BetaManagedAgentsTokenEndpointAuthPostResponse struct{…}` Token endpoint uses POST body authentication with client credentials. - `Type BetaManagedAgentsTokenEndpointAuthPostResponseType` - `const BetaManagedAgentsTokenEndpointAuthPostResponseTypeClientSecretPost BetaManagedAgentsTokenEndpointAuthPostResponseType = "client_secret_post"` - `Resource string` OAuth resource indicator. - `Scope string` OAuth scope for the refresh request. - `type BetaManagedAgentsStaticBearerAuthResponse struct{…}` Static bearer token credential details for an MCP server. - `MCPServerURL string` URL of the MCP server this credential authenticates against. - `Type BetaManagedAgentsStaticBearerAuthResponseType` - `const BetaManagedAgentsStaticBearerAuthResponseTypeStaticBearer BetaManagedAgentsStaticBearerAuthResponseType = "static_bearer"` - `CreatedAt Time` A timestamp in RFC 3339 format - `Metadata map[string, string]` Arbitrary key-value metadata attached to the credential. - `Type BetaManagedAgentsCredentialType` - `const BetaManagedAgentsCredentialTypeVaultCredential BetaManagedAgentsCredentialType = "vault_credential"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `VaultID string` Identifier of the vault this credential belongs to. - `DisplayName string` Human-readable name for the credential. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsCredential, err := client.Beta.Vaults.Credentials.New( context.TODO(), "vlt_011CZkZDLs7fYzm1hXNPeRjv", anthropic.BetaVaultCredentialNewParams{ Auth: anthropic.BetaVaultCredentialNewParamsAuthUnion{ OfStaticBearer: &anthropic.BetaManagedAgentsStaticBearerCreateParams{ Token: "bearer_exampletoken", MCPServerURL: "https://example-server.modelcontextprotocol.io/sse", Type: anthropic.BetaManagedAgentsStaticBearerCreateParamsTypeStaticBearer, }, }, }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsCredential.ID) } ``` #### Response ```json { "id": "vcrd_011CZkZEMt8gZan2iYOQfSkw", "archived_at": null, "auth": { "mcp_server_url": "https://example-server.modelcontextprotocol.io/sse", "type": "static_bearer" }, "created_at": "2026-03-15T10:00:00Z", "metadata": { "environment": "production" }, "type": "vault_credential", "updated_at": "2026-03-15T10:00:00Z", "vault_id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "display_name": "Example credential" } ``` ## List Credentials `client.Beta.Vaults.Credentials.List(ctx, vaultID, params) (*PageCursor[BetaManagedAgentsCredential], error)` **get** `/v1/vaults/{vault_id}/credentials` List Credentials ### Parameters - `vaultID string` - `params BetaVaultCredentialListParams` - `IncludeArchived param.Field[bool]` Query param: Whether to include archived credentials in the results. - `Limit param.Field[int64]` Query param: Maximum number of credentials to return per page. Defaults to 20, maximum 100. - `Page param.Field[string]` Query param: Opaque pagination token from a previous `list_credentials` response. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsCredential struct{…}` A credential stored in a vault. Sensitive fields are never returned in responses. - `ID string` Unique identifier for the credential. - `ArchivedAt Time` A timestamp in RFC 3339 format - `Auth BetaManagedAgentsCredentialAuthUnion` Authentication details for a credential. - `type BetaManagedAgentsMCPOAuthAuthResponse struct{…}` OAuth credential details for an MCP server. - `MCPServerURL string` URL of the MCP server this credential authenticates against. - `Type BetaManagedAgentsMCPOAuthAuthResponseType` - `const BetaManagedAgentsMCPOAuthAuthResponseTypeMCPOAuth BetaManagedAgentsMCPOAuthAuthResponseType = "mcp_oauth"` - `ExpiresAt Time` A timestamp in RFC 3339 format - `Refresh BetaManagedAgentsMCPOAuthRefreshResponse` OAuth refresh token configuration returned in credential responses. - `ClientID string` OAuth client ID. - `TokenEndpoint string` Token endpoint URL used to refresh the access token. - `TokenEndpointAuth BetaManagedAgentsMCPOAuthRefreshResponseTokenEndpointAuthUnion` Token endpoint requires no client authentication. - `type BetaManagedAgentsTokenEndpointAuthNoneResponse struct{…}` Token endpoint requires no client authentication. - `Type BetaManagedAgentsTokenEndpointAuthNoneResponseType` - `const BetaManagedAgentsTokenEndpointAuthNoneResponseTypeNone BetaManagedAgentsTokenEndpointAuthNoneResponseType = "none"` - `type BetaManagedAgentsTokenEndpointAuthBasicResponse struct{…}` Token endpoint uses HTTP Basic authentication with client credentials. - `Type BetaManagedAgentsTokenEndpointAuthBasicResponseType` - `const BetaManagedAgentsTokenEndpointAuthBasicResponseTypeClientSecretBasic BetaManagedAgentsTokenEndpointAuthBasicResponseType = "client_secret_basic"` - `type BetaManagedAgentsTokenEndpointAuthPostResponse struct{…}` Token endpoint uses POST body authentication with client credentials. - `Type BetaManagedAgentsTokenEndpointAuthPostResponseType` - `const BetaManagedAgentsTokenEndpointAuthPostResponseTypeClientSecretPost BetaManagedAgentsTokenEndpointAuthPostResponseType = "client_secret_post"` - `Resource string` OAuth resource indicator. - `Scope string` OAuth scope for the refresh request. - `type BetaManagedAgentsStaticBearerAuthResponse struct{…}` Static bearer token credential details for an MCP server. - `MCPServerURL string` URL of the MCP server this credential authenticates against. - `Type BetaManagedAgentsStaticBearerAuthResponseType` - `const BetaManagedAgentsStaticBearerAuthResponseTypeStaticBearer BetaManagedAgentsStaticBearerAuthResponseType = "static_bearer"` - `CreatedAt Time` A timestamp in RFC 3339 format - `Metadata map[string, string]` Arbitrary key-value metadata attached to the credential. - `Type BetaManagedAgentsCredentialType` - `const BetaManagedAgentsCredentialTypeVaultCredential BetaManagedAgentsCredentialType = "vault_credential"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `VaultID string` Identifier of the vault this credential belongs to. - `DisplayName string` Human-readable name for the credential. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) page, err := client.Beta.Vaults.Credentials.List( context.TODO(), "vlt_011CZkZDLs7fYzm1hXNPeRjv", anthropic.BetaVaultCredentialListParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "data": [ { "id": "vcrd_011CZkZEMt8gZan2iYOQfSkw", "archived_at": null, "auth": { "mcp_server_url": "https://example-server.modelcontextprotocol.io/sse", "type": "static_bearer" }, "created_at": "2026-03-15T10:00:00Z", "metadata": { "environment": "production" }, "type": "vault_credential", "updated_at": "2026-03-15T10:00:00Z", "vault_id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "display_name": "Example credential" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ## Get Credential `client.Beta.Vaults.Credentials.Get(ctx, credentialID, params) (*BetaManagedAgentsCredential, error)` **get** `/v1/vaults/{vault_id}/credentials/{credential_id}` Get Credential ### Parameters - `credentialID string` - `params BetaVaultCredentialGetParams` - `VaultID param.Field[string]` Path param: Path parameter vault_id - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsCredential struct{…}` A credential stored in a vault. Sensitive fields are never returned in responses. - `ID string` Unique identifier for the credential. - `ArchivedAt Time` A timestamp in RFC 3339 format - `Auth BetaManagedAgentsCredentialAuthUnion` Authentication details for a credential. - `type BetaManagedAgentsMCPOAuthAuthResponse struct{…}` OAuth credential details for an MCP server. - `MCPServerURL string` URL of the MCP server this credential authenticates against. - `Type BetaManagedAgentsMCPOAuthAuthResponseType` - `const BetaManagedAgentsMCPOAuthAuthResponseTypeMCPOAuth BetaManagedAgentsMCPOAuthAuthResponseType = "mcp_oauth"` - `ExpiresAt Time` A timestamp in RFC 3339 format - `Refresh BetaManagedAgentsMCPOAuthRefreshResponse` OAuth refresh token configuration returned in credential responses. - `ClientID string` OAuth client ID. - `TokenEndpoint string` Token endpoint URL used to refresh the access token. - `TokenEndpointAuth BetaManagedAgentsMCPOAuthRefreshResponseTokenEndpointAuthUnion` Token endpoint requires no client authentication. - `type BetaManagedAgentsTokenEndpointAuthNoneResponse struct{…}` Token endpoint requires no client authentication. - `Type BetaManagedAgentsTokenEndpointAuthNoneResponseType` - `const BetaManagedAgentsTokenEndpointAuthNoneResponseTypeNone BetaManagedAgentsTokenEndpointAuthNoneResponseType = "none"` - `type BetaManagedAgentsTokenEndpointAuthBasicResponse struct{…}` Token endpoint uses HTTP Basic authentication with client credentials. - `Type BetaManagedAgentsTokenEndpointAuthBasicResponseType` - `const BetaManagedAgentsTokenEndpointAuthBasicResponseTypeClientSecretBasic BetaManagedAgentsTokenEndpointAuthBasicResponseType = "client_secret_basic"` - `type BetaManagedAgentsTokenEndpointAuthPostResponse struct{…}` Token endpoint uses POST body authentication with client credentials. - `Type BetaManagedAgentsTokenEndpointAuthPostResponseType` - `const BetaManagedAgentsTokenEndpointAuthPostResponseTypeClientSecretPost BetaManagedAgentsTokenEndpointAuthPostResponseType = "client_secret_post"` - `Resource string` OAuth resource indicator. - `Scope string` OAuth scope for the refresh request. - `type BetaManagedAgentsStaticBearerAuthResponse struct{…}` Static bearer token credential details for an MCP server. - `MCPServerURL string` URL of the MCP server this credential authenticates against. - `Type BetaManagedAgentsStaticBearerAuthResponseType` - `const BetaManagedAgentsStaticBearerAuthResponseTypeStaticBearer BetaManagedAgentsStaticBearerAuthResponseType = "static_bearer"` - `CreatedAt Time` A timestamp in RFC 3339 format - `Metadata map[string, string]` Arbitrary key-value metadata attached to the credential. - `Type BetaManagedAgentsCredentialType` - `const BetaManagedAgentsCredentialTypeVaultCredential BetaManagedAgentsCredentialType = "vault_credential"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `VaultID string` Identifier of the vault this credential belongs to. - `DisplayName string` Human-readable name for the credential. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsCredential, err := client.Beta.Vaults.Credentials.Get( context.TODO(), "vcrd_011CZkZEMt8gZan2iYOQfSkw", anthropic.BetaVaultCredentialGetParams{ VaultID: "vlt_011CZkZDLs7fYzm1hXNPeRjv", }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsCredential.ID) } ``` #### Response ```json { "id": "vcrd_011CZkZEMt8gZan2iYOQfSkw", "archived_at": null, "auth": { "mcp_server_url": "https://example-server.modelcontextprotocol.io/sse", "type": "static_bearer" }, "created_at": "2026-03-15T10:00:00Z", "metadata": { "environment": "production" }, "type": "vault_credential", "updated_at": "2026-03-15T10:00:00Z", "vault_id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "display_name": "Example credential" } ``` ## Update Credential `client.Beta.Vaults.Credentials.Update(ctx, credentialID, params) (*BetaManagedAgentsCredential, error)` **post** `/v1/vaults/{vault_id}/credentials/{credential_id}` Update Credential ### Parameters - `credentialID string` - `params BetaVaultCredentialUpdateParams` - `VaultID param.Field[string]` Path param: Path parameter vault_id - `Auth param.Field[BetaVaultCredentialUpdateParamsAuthUnion]` Body param: Updated authentication details for a credential. - `type BetaManagedAgentsMCPOAuthUpdateParamsResp struct{…}` Parameters for updating an MCP OAuth credential. The `mcp_server_url` is immutable. - `Type BetaManagedAgentsMCPOAuthUpdateParamsType` - `const BetaManagedAgentsMCPOAuthUpdateParamsTypeMCPOAuth BetaManagedAgentsMCPOAuthUpdateParamsType = "mcp_oauth"` - `AccessToken string` Updated OAuth access token. - `ExpiresAt Time` A timestamp in RFC 3339 format - `Refresh BetaManagedAgentsMCPOAuthRefreshUpdateParamsResp` Parameters for updating OAuth refresh token configuration. - `RefreshToken string` Updated OAuth refresh token. - `Scope string` Updated OAuth scope for the refresh request. - `TokenEndpointAuth BetaManagedAgentsMCPOAuthRefreshUpdateParamsTokenEndpointAuthUnionResp` Updated HTTP Basic authentication parameters for the token endpoint. - `type BetaManagedAgentsTokenEndpointAuthBasicUpdateParamResp struct{…}` Updated HTTP Basic authentication parameters for the token endpoint. - `Type BetaManagedAgentsTokenEndpointAuthBasicUpdateParamType` - `const BetaManagedAgentsTokenEndpointAuthBasicUpdateParamTypeClientSecretBasic BetaManagedAgentsTokenEndpointAuthBasicUpdateParamType = "client_secret_basic"` - `ClientSecret string` Updated OAuth client secret. - `type BetaManagedAgentsTokenEndpointAuthPostUpdateParamResp struct{…}` Updated POST body authentication parameters for the token endpoint. - `Type BetaManagedAgentsTokenEndpointAuthPostUpdateParamType` - `const BetaManagedAgentsTokenEndpointAuthPostUpdateParamTypeClientSecretPost BetaManagedAgentsTokenEndpointAuthPostUpdateParamType = "client_secret_post"` - `ClientSecret string` Updated OAuth client secret. - `type BetaManagedAgentsStaticBearerUpdateParamsResp struct{…}` Parameters for updating a static bearer token credential. The `mcp_server_url` is immutable. - `Type BetaManagedAgentsStaticBearerUpdateParamsType` - `const BetaManagedAgentsStaticBearerUpdateParamsTypeStaticBearer BetaManagedAgentsStaticBearerUpdateParamsType = "static_bearer"` - `Token string` Updated static bearer token value. - `DisplayName param.Field[string]` Body param: Updated human-readable name for the credential. 1-255 characters. - `Metadata param.Field[map[string, string]]` Body param: Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omitted keys are preserved. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsCredential struct{…}` A credential stored in a vault. Sensitive fields are never returned in responses. - `ID string` Unique identifier for the credential. - `ArchivedAt Time` A timestamp in RFC 3339 format - `Auth BetaManagedAgentsCredentialAuthUnion` Authentication details for a credential. - `type BetaManagedAgentsMCPOAuthAuthResponse struct{…}` OAuth credential details for an MCP server. - `MCPServerURL string` URL of the MCP server this credential authenticates against. - `Type BetaManagedAgentsMCPOAuthAuthResponseType` - `const BetaManagedAgentsMCPOAuthAuthResponseTypeMCPOAuth BetaManagedAgentsMCPOAuthAuthResponseType = "mcp_oauth"` - `ExpiresAt Time` A timestamp in RFC 3339 format - `Refresh BetaManagedAgentsMCPOAuthRefreshResponse` OAuth refresh token configuration returned in credential responses. - `ClientID string` OAuth client ID. - `TokenEndpoint string` Token endpoint URL used to refresh the access token. - `TokenEndpointAuth BetaManagedAgentsMCPOAuthRefreshResponseTokenEndpointAuthUnion` Token endpoint requires no client authentication. - `type BetaManagedAgentsTokenEndpointAuthNoneResponse struct{…}` Token endpoint requires no client authentication. - `Type BetaManagedAgentsTokenEndpointAuthNoneResponseType` - `const BetaManagedAgentsTokenEndpointAuthNoneResponseTypeNone BetaManagedAgentsTokenEndpointAuthNoneResponseType = "none"` - `type BetaManagedAgentsTokenEndpointAuthBasicResponse struct{…}` Token endpoint uses HTTP Basic authentication with client credentials. - `Type BetaManagedAgentsTokenEndpointAuthBasicResponseType` - `const BetaManagedAgentsTokenEndpointAuthBasicResponseTypeClientSecretBasic BetaManagedAgentsTokenEndpointAuthBasicResponseType = "client_secret_basic"` - `type BetaManagedAgentsTokenEndpointAuthPostResponse struct{…}` Token endpoint uses POST body authentication with client credentials. - `Type BetaManagedAgentsTokenEndpointAuthPostResponseType` - `const BetaManagedAgentsTokenEndpointAuthPostResponseTypeClientSecretPost BetaManagedAgentsTokenEndpointAuthPostResponseType = "client_secret_post"` - `Resource string` OAuth resource indicator. - `Scope string` OAuth scope for the refresh request. - `type BetaManagedAgentsStaticBearerAuthResponse struct{…}` Static bearer token credential details for an MCP server. - `MCPServerURL string` URL of the MCP server this credential authenticates against. - `Type BetaManagedAgentsStaticBearerAuthResponseType` - `const BetaManagedAgentsStaticBearerAuthResponseTypeStaticBearer BetaManagedAgentsStaticBearerAuthResponseType = "static_bearer"` - `CreatedAt Time` A timestamp in RFC 3339 format - `Metadata map[string, string]` Arbitrary key-value metadata attached to the credential. - `Type BetaManagedAgentsCredentialType` - `const BetaManagedAgentsCredentialTypeVaultCredential BetaManagedAgentsCredentialType = "vault_credential"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `VaultID string` Identifier of the vault this credential belongs to. - `DisplayName string` Human-readable name for the credential. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsCredential, err := client.Beta.Vaults.Credentials.Update( context.TODO(), "vcrd_011CZkZEMt8gZan2iYOQfSkw", anthropic.BetaVaultCredentialUpdateParams{ VaultID: "vlt_011CZkZDLs7fYzm1hXNPeRjv", }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsCredential.ID) } ``` #### Response ```json { "id": "vcrd_011CZkZEMt8gZan2iYOQfSkw", "archived_at": null, "auth": { "mcp_server_url": "https://example-server.modelcontextprotocol.io/sse", "type": "static_bearer" }, "created_at": "2026-03-15T10:00:00Z", "metadata": { "environment": "production" }, "type": "vault_credential", "updated_at": "2026-03-15T10:00:00Z", "vault_id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "display_name": "Example credential" } ``` ## Delete Credential `client.Beta.Vaults.Credentials.Delete(ctx, credentialID, params) (*BetaManagedAgentsDeletedCredential, error)` **delete** `/v1/vaults/{vault_id}/credentials/{credential_id}` Delete Credential ### Parameters - `credentialID string` - `params BetaVaultCredentialDeleteParams` - `VaultID param.Field[string]` Path param: Path parameter vault_id - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsDeletedCredential struct{…}` Confirmation of a deleted credential. - `ID string` Unique identifier of the deleted credential. - `Type BetaManagedAgentsDeletedCredentialType` - `const BetaManagedAgentsDeletedCredentialTypeVaultCredentialDeleted BetaManagedAgentsDeletedCredentialType = "vault_credential_deleted"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsDeletedCredential, err := client.Beta.Vaults.Credentials.Delete( context.TODO(), "vcrd_011CZkZEMt8gZan2iYOQfSkw", anthropic.BetaVaultCredentialDeleteParams{ VaultID: "vlt_011CZkZDLs7fYzm1hXNPeRjv", }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsDeletedCredential.ID) } ``` #### Response ```json { "id": "vcrd_011CZkZEMt8gZan2iYOQfSkw", "type": "vault_credential_deleted" } ``` ## Archive Credential `client.Beta.Vaults.Credentials.Archive(ctx, credentialID, params) (*BetaManagedAgentsCredential, error)` **post** `/v1/vaults/{vault_id}/credentials/{credential_id}/archive` Archive Credential ### Parameters - `credentialID string` - `params BetaVaultCredentialArchiveParams` - `VaultID param.Field[string]` Path param: Path parameter vault_id - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsCredential struct{…}` A credential stored in a vault. Sensitive fields are never returned in responses. - `ID string` Unique identifier for the credential. - `ArchivedAt Time` A timestamp in RFC 3339 format - `Auth BetaManagedAgentsCredentialAuthUnion` Authentication details for a credential. - `type BetaManagedAgentsMCPOAuthAuthResponse struct{…}` OAuth credential details for an MCP server. - `MCPServerURL string` URL of the MCP server this credential authenticates against. - `Type BetaManagedAgentsMCPOAuthAuthResponseType` - `const BetaManagedAgentsMCPOAuthAuthResponseTypeMCPOAuth BetaManagedAgentsMCPOAuthAuthResponseType = "mcp_oauth"` - `ExpiresAt Time` A timestamp in RFC 3339 format - `Refresh BetaManagedAgentsMCPOAuthRefreshResponse` OAuth refresh token configuration returned in credential responses. - `ClientID string` OAuth client ID. - `TokenEndpoint string` Token endpoint URL used to refresh the access token. - `TokenEndpointAuth BetaManagedAgentsMCPOAuthRefreshResponseTokenEndpointAuthUnion` Token endpoint requires no client authentication. - `type BetaManagedAgentsTokenEndpointAuthNoneResponse struct{…}` Token endpoint requires no client authentication. - `Type BetaManagedAgentsTokenEndpointAuthNoneResponseType` - `const BetaManagedAgentsTokenEndpointAuthNoneResponseTypeNone BetaManagedAgentsTokenEndpointAuthNoneResponseType = "none"` - `type BetaManagedAgentsTokenEndpointAuthBasicResponse struct{…}` Token endpoint uses HTTP Basic authentication with client credentials. - `Type BetaManagedAgentsTokenEndpointAuthBasicResponseType` - `const BetaManagedAgentsTokenEndpointAuthBasicResponseTypeClientSecretBasic BetaManagedAgentsTokenEndpointAuthBasicResponseType = "client_secret_basic"` - `type BetaManagedAgentsTokenEndpointAuthPostResponse struct{…}` Token endpoint uses POST body authentication with client credentials. - `Type BetaManagedAgentsTokenEndpointAuthPostResponseType` - `const BetaManagedAgentsTokenEndpointAuthPostResponseTypeClientSecretPost BetaManagedAgentsTokenEndpointAuthPostResponseType = "client_secret_post"` - `Resource string` OAuth resource indicator. - `Scope string` OAuth scope for the refresh request. - `type BetaManagedAgentsStaticBearerAuthResponse struct{…}` Static bearer token credential details for an MCP server. - `MCPServerURL string` URL of the MCP server this credential authenticates against. - `Type BetaManagedAgentsStaticBearerAuthResponseType` - `const BetaManagedAgentsStaticBearerAuthResponseTypeStaticBearer BetaManagedAgentsStaticBearerAuthResponseType = "static_bearer"` - `CreatedAt Time` A timestamp in RFC 3339 format - `Metadata map[string, string]` Arbitrary key-value metadata attached to the credential. - `Type BetaManagedAgentsCredentialType` - `const BetaManagedAgentsCredentialTypeVaultCredential BetaManagedAgentsCredentialType = "vault_credential"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `VaultID string` Identifier of the vault this credential belongs to. - `DisplayName string` Human-readable name for the credential. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsCredential, err := client.Beta.Vaults.Credentials.Archive( context.TODO(), "vcrd_011CZkZEMt8gZan2iYOQfSkw", anthropic.BetaVaultCredentialArchiveParams{ VaultID: "vlt_011CZkZDLs7fYzm1hXNPeRjv", }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsCredential.ID) } ``` #### Response ```json { "id": "vcrd_011CZkZEMt8gZan2iYOQfSkw", "archived_at": null, "auth": { "mcp_server_url": "https://example-server.modelcontextprotocol.io/sse", "type": "static_bearer" }, "created_at": "2026-03-15T10:00:00Z", "metadata": { "environment": "production" }, "type": "vault_credential", "updated_at": "2026-03-15T10:00:00Z", "vault_id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "display_name": "Example credential" } ``` ## Validate Credential `client.Beta.Vaults.Credentials.MCPOAuthValidate(ctx, credentialID, params) (*BetaManagedAgentsCredentialValidation, error)` **post** `/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate` Validate Credential ### Parameters - `credentialID string` - `params BetaVaultCredentialMCPOAuthValidateParams` - `VaultID param.Field[string]` Path param: Path parameter vault_id - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsCredentialValidation struct{…}` Result of live-probing a credential against its configured MCP server. - `CredentialID string` Unique identifier of the credential that was validated. - `HasRefreshToken bool` Whether the credential has a refresh token configured. - `MCPProbe BetaManagedAgentsMCPProbe` The failing step of an MCP validation probe. - `HTTPResponse BetaManagedAgentsRefreshHTTPResponse` An HTTP response captured during a credential validation probe. - `Body string` Response body. May be truncated and has sensitive values scrubbed. - `BodyTruncated bool` Whether `body` was truncated. - `ContentType string` Value of the `Content-Type` response header. - `StatusCode int64` HTTP status code. - `Method string` The MCP method that failed (for example `initialize` or `tools/list`). - `Refresh BetaManagedAgentsRefreshObject` Outcome of a refresh-token exchange attempted during credential validation. - `HTTPResponse BetaManagedAgentsRefreshHTTPResponse` An HTTP response captured during a credential validation probe. - `Status BetaManagedAgentsRefreshObjectStatus` Outcome of a refresh-token exchange attempted during credential validation. - `const BetaManagedAgentsRefreshObjectStatusSucceeded BetaManagedAgentsRefreshObjectStatus = "succeeded"` - `const BetaManagedAgentsRefreshObjectStatusFailed BetaManagedAgentsRefreshObjectStatus = "failed"` - `const BetaManagedAgentsRefreshObjectStatusConnectError BetaManagedAgentsRefreshObjectStatus = "connect_error"` - `const BetaManagedAgentsRefreshObjectStatusNoRefreshToken BetaManagedAgentsRefreshObjectStatus = "no_refresh_token"` - `Status BetaManagedAgentsCredentialValidationStatus` Overall verdict of a credential validation probe. - `const BetaManagedAgentsCredentialValidationStatusValid BetaManagedAgentsCredentialValidationStatus = "valid"` - `const BetaManagedAgentsCredentialValidationStatusInvalid BetaManagedAgentsCredentialValidationStatus = "invalid"` - `const BetaManagedAgentsCredentialValidationStatusUnknown BetaManagedAgentsCredentialValidationStatus = "unknown"` - `Type BetaManagedAgentsCredentialValidationType` - `const BetaManagedAgentsCredentialValidationTypeVaultCredentialValidation BetaManagedAgentsCredentialValidationType = "vault_credential_validation"` - `ValidatedAt Time` A timestamp in RFC 3339 format - `VaultID string` Identifier of the vault containing the credential. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsCredentialValidation, err := client.Beta.Vaults.Credentials.MCPOAuthValidate( context.TODO(), "vcrd_011CZkZEMt8gZan2iYOQfSkw", anthropic.BetaVaultCredentialMCPOAuthValidateParams{ VaultID: "vlt_011CZkZDLs7fYzm1hXNPeRjv", }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsCredentialValidation.CredentialID) } ``` #### Response ```json { "credential_id": "vcrd_011CZkZEMt8gZan2iYOQfSkw", "has_refresh_token": true, "mcp_probe": { "http_response": { "body": "body", "body_truncated": true, "content_type": "content_type", "status_code": 0 }, "method": "method" }, "refresh": { "http_response": { "body": "body", "body_truncated": true, "content_type": "content_type", "status_code": 0 }, "status": "succeeded" }, "status": "valid", "type": "vault_credential_validation", "validated_at": "2026-03-15T10:00:00Z", "vault_id": "vlt_011CZkZDLs7fYzm1hXNPeRjv" } ``` ## Domain Types ### Beta Managed Agents Credential - `type BetaManagedAgentsCredential struct{…}` A credential stored in a vault. Sensitive fields are never returned in responses. - `ID string` Unique identifier for the credential. - `ArchivedAt Time` A timestamp in RFC 3339 format - `Auth BetaManagedAgentsCredentialAuthUnion` Authentication details for a credential. - `type BetaManagedAgentsMCPOAuthAuthResponse struct{…}` OAuth credential details for an MCP server. - `MCPServerURL string` URL of the MCP server this credential authenticates against. - `Type BetaManagedAgentsMCPOAuthAuthResponseType` - `const BetaManagedAgentsMCPOAuthAuthResponseTypeMCPOAuth BetaManagedAgentsMCPOAuthAuthResponseType = "mcp_oauth"` - `ExpiresAt Time` A timestamp in RFC 3339 format - `Refresh BetaManagedAgentsMCPOAuthRefreshResponse` OAuth refresh token configuration returned in credential responses. - `ClientID string` OAuth client ID. - `TokenEndpoint string` Token endpoint URL used to refresh the access token. - `TokenEndpointAuth BetaManagedAgentsMCPOAuthRefreshResponseTokenEndpointAuthUnion` Token endpoint requires no client authentication. - `type BetaManagedAgentsTokenEndpointAuthNoneResponse struct{…}` Token endpoint requires no client authentication. - `Type BetaManagedAgentsTokenEndpointAuthNoneResponseType` - `const BetaManagedAgentsTokenEndpointAuthNoneResponseTypeNone BetaManagedAgentsTokenEndpointAuthNoneResponseType = "none"` - `type BetaManagedAgentsTokenEndpointAuthBasicResponse struct{…}` Token endpoint uses HTTP Basic authentication with client credentials. - `Type BetaManagedAgentsTokenEndpointAuthBasicResponseType` - `const BetaManagedAgentsTokenEndpointAuthBasicResponseTypeClientSecretBasic BetaManagedAgentsTokenEndpointAuthBasicResponseType = "client_secret_basic"` - `type BetaManagedAgentsTokenEndpointAuthPostResponse struct{…}` Token endpoint uses POST body authentication with client credentials. - `Type BetaManagedAgentsTokenEndpointAuthPostResponseType` - `const BetaManagedAgentsTokenEndpointAuthPostResponseTypeClientSecretPost BetaManagedAgentsTokenEndpointAuthPostResponseType = "client_secret_post"` - `Resource string` OAuth resource indicator. - `Scope string` OAuth scope for the refresh request. - `type BetaManagedAgentsStaticBearerAuthResponse struct{…}` Static bearer token credential details for an MCP server. - `MCPServerURL string` URL of the MCP server this credential authenticates against. - `Type BetaManagedAgentsStaticBearerAuthResponseType` - `const BetaManagedAgentsStaticBearerAuthResponseTypeStaticBearer BetaManagedAgentsStaticBearerAuthResponseType = "static_bearer"` - `CreatedAt Time` A timestamp in RFC 3339 format - `Metadata map[string, string]` Arbitrary key-value metadata attached to the credential. - `Type BetaManagedAgentsCredentialType` - `const BetaManagedAgentsCredentialTypeVaultCredential BetaManagedAgentsCredentialType = "vault_credential"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `VaultID string` Identifier of the vault this credential belongs to. - `DisplayName string` Human-readable name for the credential. ### Beta Managed Agents Credential Validation - `type BetaManagedAgentsCredentialValidation struct{…}` Result of live-probing a credential against its configured MCP server. - `CredentialID string` Unique identifier of the credential that was validated. - `HasRefreshToken bool` Whether the credential has a refresh token configured. - `MCPProbe BetaManagedAgentsMCPProbe` The failing step of an MCP validation probe. - `HTTPResponse BetaManagedAgentsRefreshHTTPResponse` An HTTP response captured during a credential validation probe. - `Body string` Response body. May be truncated and has sensitive values scrubbed. - `BodyTruncated bool` Whether `body` was truncated. - `ContentType string` Value of the `Content-Type` response header. - `StatusCode int64` HTTP status code. - `Method string` The MCP method that failed (for example `initialize` or `tools/list`). - `Refresh BetaManagedAgentsRefreshObject` Outcome of a refresh-token exchange attempted during credential validation. - `HTTPResponse BetaManagedAgentsRefreshHTTPResponse` An HTTP response captured during a credential validation probe. - `Status BetaManagedAgentsRefreshObjectStatus` Outcome of a refresh-token exchange attempted during credential validation. - `const BetaManagedAgentsRefreshObjectStatusSucceeded BetaManagedAgentsRefreshObjectStatus = "succeeded"` - `const BetaManagedAgentsRefreshObjectStatusFailed BetaManagedAgentsRefreshObjectStatus = "failed"` - `const BetaManagedAgentsRefreshObjectStatusConnectError BetaManagedAgentsRefreshObjectStatus = "connect_error"` - `const BetaManagedAgentsRefreshObjectStatusNoRefreshToken BetaManagedAgentsRefreshObjectStatus = "no_refresh_token"` - `Status BetaManagedAgentsCredentialValidationStatus` Overall verdict of a credential validation probe. - `const BetaManagedAgentsCredentialValidationStatusValid BetaManagedAgentsCredentialValidationStatus = "valid"` - `const BetaManagedAgentsCredentialValidationStatusInvalid BetaManagedAgentsCredentialValidationStatus = "invalid"` - `const BetaManagedAgentsCredentialValidationStatusUnknown BetaManagedAgentsCredentialValidationStatus = "unknown"` - `Type BetaManagedAgentsCredentialValidationType` - `const BetaManagedAgentsCredentialValidationTypeVaultCredentialValidation BetaManagedAgentsCredentialValidationType = "vault_credential_validation"` - `ValidatedAt Time` A timestamp in RFC 3339 format - `VaultID string` Identifier of the vault containing the credential. ### Beta Managed Agents Credential Validation Status - `type BetaManagedAgentsCredentialValidationStatus string` Overall verdict of a credential validation probe. - `const BetaManagedAgentsCredentialValidationStatusValid BetaManagedAgentsCredentialValidationStatus = "valid"` - `const BetaManagedAgentsCredentialValidationStatusInvalid BetaManagedAgentsCredentialValidationStatus = "invalid"` - `const BetaManagedAgentsCredentialValidationStatusUnknown BetaManagedAgentsCredentialValidationStatus = "unknown"` ### Beta Managed Agents Deleted Credential - `type BetaManagedAgentsDeletedCredential struct{…}` Confirmation of a deleted credential. - `ID string` Unique identifier of the deleted credential. - `Type BetaManagedAgentsDeletedCredentialType` - `const BetaManagedAgentsDeletedCredentialTypeVaultCredentialDeleted BetaManagedAgentsDeletedCredentialType = "vault_credential_deleted"` ### Beta Managed Agents MCP OAuth Auth Response - `type BetaManagedAgentsMCPOAuthAuthResponse struct{…}` OAuth credential details for an MCP server. - `MCPServerURL string` URL of the MCP server this credential authenticates against. - `Type BetaManagedAgentsMCPOAuthAuthResponseType` - `const BetaManagedAgentsMCPOAuthAuthResponseTypeMCPOAuth BetaManagedAgentsMCPOAuthAuthResponseType = "mcp_oauth"` - `ExpiresAt Time` A timestamp in RFC 3339 format - `Refresh BetaManagedAgentsMCPOAuthRefreshResponse` OAuth refresh token configuration returned in credential responses. - `ClientID string` OAuth client ID. - `TokenEndpoint string` Token endpoint URL used to refresh the access token. - `TokenEndpointAuth BetaManagedAgentsMCPOAuthRefreshResponseTokenEndpointAuthUnion` Token endpoint requires no client authentication. - `type BetaManagedAgentsTokenEndpointAuthNoneResponse struct{…}` Token endpoint requires no client authentication. - `Type BetaManagedAgentsTokenEndpointAuthNoneResponseType` - `const BetaManagedAgentsTokenEndpointAuthNoneResponseTypeNone BetaManagedAgentsTokenEndpointAuthNoneResponseType = "none"` - `type BetaManagedAgentsTokenEndpointAuthBasicResponse struct{…}` Token endpoint uses HTTP Basic authentication with client credentials. - `Type BetaManagedAgentsTokenEndpointAuthBasicResponseType` - `const BetaManagedAgentsTokenEndpointAuthBasicResponseTypeClientSecretBasic BetaManagedAgentsTokenEndpointAuthBasicResponseType = "client_secret_basic"` - `type BetaManagedAgentsTokenEndpointAuthPostResponse struct{…}` Token endpoint uses POST body authentication with client credentials. - `Type BetaManagedAgentsTokenEndpointAuthPostResponseType` - `const BetaManagedAgentsTokenEndpointAuthPostResponseTypeClientSecretPost BetaManagedAgentsTokenEndpointAuthPostResponseType = "client_secret_post"` - `Resource string` OAuth resource indicator. - `Scope string` OAuth scope for the refresh request. ### Beta Managed Agents MCP OAuth Create Params - `type BetaManagedAgentsMCPOAuthCreateParamsResp struct{…}` Parameters for creating an MCP OAuth credential. - `AccessToken string` OAuth access token. - `MCPServerURL string` URL of the MCP server this credential authenticates against. - `Type BetaManagedAgentsMCPOAuthCreateParamsType` - `const BetaManagedAgentsMCPOAuthCreateParamsTypeMCPOAuth BetaManagedAgentsMCPOAuthCreateParamsType = "mcp_oauth"` - `ExpiresAt Time` A timestamp in RFC 3339 format - `Refresh BetaManagedAgentsMCPOAuthRefreshParamsResp` OAuth refresh token parameters for creating a credential with refresh support. - `ClientID string` OAuth client ID. - `RefreshToken string` OAuth refresh token. - `TokenEndpoint string` Token endpoint URL used to refresh the access token. - `TokenEndpointAuth BetaManagedAgentsMCPOAuthRefreshParamsTokenEndpointAuthUnionResp` Token endpoint requires no client authentication. - `type BetaManagedAgentsTokenEndpointAuthNoneParamResp struct{…}` Token endpoint requires no client authentication. - `Type BetaManagedAgentsTokenEndpointAuthNoneParamType` - `const BetaManagedAgentsTokenEndpointAuthNoneParamTypeNone BetaManagedAgentsTokenEndpointAuthNoneParamType = "none"` - `type BetaManagedAgentsTokenEndpointAuthBasicParamResp struct{…}` Token endpoint uses HTTP Basic authentication with client credentials. - `ClientSecret string` OAuth client secret. - `Type BetaManagedAgentsTokenEndpointAuthBasicParamType` - `const BetaManagedAgentsTokenEndpointAuthBasicParamTypeClientSecretBasic BetaManagedAgentsTokenEndpointAuthBasicParamType = "client_secret_basic"` - `type BetaManagedAgentsTokenEndpointAuthPostParamResp struct{…}` Token endpoint uses POST body authentication with client credentials. - `ClientSecret string` OAuth client secret. - `Type BetaManagedAgentsTokenEndpointAuthPostParamType` - `const BetaManagedAgentsTokenEndpointAuthPostParamTypeClientSecretPost BetaManagedAgentsTokenEndpointAuthPostParamType = "client_secret_post"` - `Resource string` OAuth resource indicator. - `Scope string` OAuth scope for the refresh request. ### Beta Managed Agents MCP OAuth Refresh Params - `type BetaManagedAgentsMCPOAuthRefreshParamsResp struct{…}` OAuth refresh token parameters for creating a credential with refresh support. - `ClientID string` OAuth client ID. - `RefreshToken string` OAuth refresh token. - `TokenEndpoint string` Token endpoint URL used to refresh the access token. - `TokenEndpointAuth BetaManagedAgentsMCPOAuthRefreshParamsTokenEndpointAuthUnionResp` Token endpoint requires no client authentication. - `type BetaManagedAgentsTokenEndpointAuthNoneParamResp struct{…}` Token endpoint requires no client authentication. - `Type BetaManagedAgentsTokenEndpointAuthNoneParamType` - `const BetaManagedAgentsTokenEndpointAuthNoneParamTypeNone BetaManagedAgentsTokenEndpointAuthNoneParamType = "none"` - `type BetaManagedAgentsTokenEndpointAuthBasicParamResp struct{…}` Token endpoint uses HTTP Basic authentication with client credentials. - `ClientSecret string` OAuth client secret. - `Type BetaManagedAgentsTokenEndpointAuthBasicParamType` - `const BetaManagedAgentsTokenEndpointAuthBasicParamTypeClientSecretBasic BetaManagedAgentsTokenEndpointAuthBasicParamType = "client_secret_basic"` - `type BetaManagedAgentsTokenEndpointAuthPostParamResp struct{…}` Token endpoint uses POST body authentication with client credentials. - `ClientSecret string` OAuth client secret. - `Type BetaManagedAgentsTokenEndpointAuthPostParamType` - `const BetaManagedAgentsTokenEndpointAuthPostParamTypeClientSecretPost BetaManagedAgentsTokenEndpointAuthPostParamType = "client_secret_post"` - `Resource string` OAuth resource indicator. - `Scope string` OAuth scope for the refresh request. ### Beta Managed Agents MCP OAuth Refresh Response - `type BetaManagedAgentsMCPOAuthRefreshResponse struct{…}` OAuth refresh token configuration returned in credential responses. - `ClientID string` OAuth client ID. - `TokenEndpoint string` Token endpoint URL used to refresh the access token. - `TokenEndpointAuth BetaManagedAgentsMCPOAuthRefreshResponseTokenEndpointAuthUnion` Token endpoint requires no client authentication. - `type BetaManagedAgentsTokenEndpointAuthNoneResponse struct{…}` Token endpoint requires no client authentication. - `Type BetaManagedAgentsTokenEndpointAuthNoneResponseType` - `const BetaManagedAgentsTokenEndpointAuthNoneResponseTypeNone BetaManagedAgentsTokenEndpointAuthNoneResponseType = "none"` - `type BetaManagedAgentsTokenEndpointAuthBasicResponse struct{…}` Token endpoint uses HTTP Basic authentication with client credentials. - `Type BetaManagedAgentsTokenEndpointAuthBasicResponseType` - `const BetaManagedAgentsTokenEndpointAuthBasicResponseTypeClientSecretBasic BetaManagedAgentsTokenEndpointAuthBasicResponseType = "client_secret_basic"` - `type BetaManagedAgentsTokenEndpointAuthPostResponse struct{…}` Token endpoint uses POST body authentication with client credentials. - `Type BetaManagedAgentsTokenEndpointAuthPostResponseType` - `const BetaManagedAgentsTokenEndpointAuthPostResponseTypeClientSecretPost BetaManagedAgentsTokenEndpointAuthPostResponseType = "client_secret_post"` - `Resource string` OAuth resource indicator. - `Scope string` OAuth scope for the refresh request. ### Beta Managed Agents MCP OAuth Refresh Update Params - `type BetaManagedAgentsMCPOAuthRefreshUpdateParamsResp struct{…}` Parameters for updating OAuth refresh token configuration. - `RefreshToken string` Updated OAuth refresh token. - `Scope string` Updated OAuth scope for the refresh request. - `TokenEndpointAuth BetaManagedAgentsMCPOAuthRefreshUpdateParamsTokenEndpointAuthUnionResp` Updated HTTP Basic authentication parameters for the token endpoint. - `type BetaManagedAgentsTokenEndpointAuthBasicUpdateParamResp struct{…}` Updated HTTP Basic authentication parameters for the token endpoint. - `Type BetaManagedAgentsTokenEndpointAuthBasicUpdateParamType` - `const BetaManagedAgentsTokenEndpointAuthBasicUpdateParamTypeClientSecretBasic BetaManagedAgentsTokenEndpointAuthBasicUpdateParamType = "client_secret_basic"` - `ClientSecret string` Updated OAuth client secret. - `type BetaManagedAgentsTokenEndpointAuthPostUpdateParamResp struct{…}` Updated POST body authentication parameters for the token endpoint. - `Type BetaManagedAgentsTokenEndpointAuthPostUpdateParamType` - `const BetaManagedAgentsTokenEndpointAuthPostUpdateParamTypeClientSecretPost BetaManagedAgentsTokenEndpointAuthPostUpdateParamType = "client_secret_post"` - `ClientSecret string` Updated OAuth client secret. ### Beta Managed Agents MCP OAuth Update Params - `type BetaManagedAgentsMCPOAuthUpdateParamsResp struct{…}` Parameters for updating an MCP OAuth credential. The `mcp_server_url` is immutable. - `Type BetaManagedAgentsMCPOAuthUpdateParamsType` - `const BetaManagedAgentsMCPOAuthUpdateParamsTypeMCPOAuth BetaManagedAgentsMCPOAuthUpdateParamsType = "mcp_oauth"` - `AccessToken string` Updated OAuth access token. - `ExpiresAt Time` A timestamp in RFC 3339 format - `Refresh BetaManagedAgentsMCPOAuthRefreshUpdateParamsResp` Parameters for updating OAuth refresh token configuration. - `RefreshToken string` Updated OAuth refresh token. - `Scope string` Updated OAuth scope for the refresh request. - `TokenEndpointAuth BetaManagedAgentsMCPOAuthRefreshUpdateParamsTokenEndpointAuthUnionResp` Updated HTTP Basic authentication parameters for the token endpoint. - `type BetaManagedAgentsTokenEndpointAuthBasicUpdateParamResp struct{…}` Updated HTTP Basic authentication parameters for the token endpoint. - `Type BetaManagedAgentsTokenEndpointAuthBasicUpdateParamType` - `const BetaManagedAgentsTokenEndpointAuthBasicUpdateParamTypeClientSecretBasic BetaManagedAgentsTokenEndpointAuthBasicUpdateParamType = "client_secret_basic"` - `ClientSecret string` Updated OAuth client secret. - `type BetaManagedAgentsTokenEndpointAuthPostUpdateParamResp struct{…}` Updated POST body authentication parameters for the token endpoint. - `Type BetaManagedAgentsTokenEndpointAuthPostUpdateParamType` - `const BetaManagedAgentsTokenEndpointAuthPostUpdateParamTypeClientSecretPost BetaManagedAgentsTokenEndpointAuthPostUpdateParamType = "client_secret_post"` - `ClientSecret string` Updated OAuth client secret. ### Beta Managed Agents MCP Probe - `type BetaManagedAgentsMCPProbe struct{…}` The failing step of an MCP validation probe. - `HTTPResponse BetaManagedAgentsRefreshHTTPResponse` An HTTP response captured during a credential validation probe. - `Body string` Response body. May be truncated and has sensitive values scrubbed. - `BodyTruncated bool` Whether `body` was truncated. - `ContentType string` Value of the `Content-Type` response header. - `StatusCode int64` HTTP status code. - `Method string` The MCP method that failed (for example `initialize` or `tools/list`). ### Beta Managed Agents Refresh HTTP Response - `type BetaManagedAgentsRefreshHTTPResponse struct{…}` An HTTP response captured during a credential validation probe. - `Body string` Response body. May be truncated and has sensitive values scrubbed. - `BodyTruncated bool` Whether `body` was truncated. - `ContentType string` Value of the `Content-Type` response header. - `StatusCode int64` HTTP status code. ### Beta Managed Agents Refresh Object - `type BetaManagedAgentsRefreshObject struct{…}` Outcome of a refresh-token exchange attempted during credential validation. - `HTTPResponse BetaManagedAgentsRefreshHTTPResponse` An HTTP response captured during a credential validation probe. - `Body string` Response body. May be truncated and has sensitive values scrubbed. - `BodyTruncated bool` Whether `body` was truncated. - `ContentType string` Value of the `Content-Type` response header. - `StatusCode int64` HTTP status code. - `Status BetaManagedAgentsRefreshObjectStatus` Outcome of a refresh-token exchange attempted during credential validation. - `const BetaManagedAgentsRefreshObjectStatusSucceeded BetaManagedAgentsRefreshObjectStatus = "succeeded"` - `const BetaManagedAgentsRefreshObjectStatusFailed BetaManagedAgentsRefreshObjectStatus = "failed"` - `const BetaManagedAgentsRefreshObjectStatusConnectError BetaManagedAgentsRefreshObjectStatus = "connect_error"` - `const BetaManagedAgentsRefreshObjectStatusNoRefreshToken BetaManagedAgentsRefreshObjectStatus = "no_refresh_token"` ### Beta Managed Agents Static Bearer Auth Response - `type BetaManagedAgentsStaticBearerAuthResponse struct{…}` Static bearer token credential details for an MCP server. - `MCPServerURL string` URL of the MCP server this credential authenticates against. - `Type BetaManagedAgentsStaticBearerAuthResponseType` - `const BetaManagedAgentsStaticBearerAuthResponseTypeStaticBearer BetaManagedAgentsStaticBearerAuthResponseType = "static_bearer"` ### Beta Managed Agents Static Bearer Create Params - `type BetaManagedAgentsStaticBearerCreateParamsResp struct{…}` Parameters for creating a static bearer token credential. - `Token string` Static bearer token value. - `MCPServerURL string` URL of the MCP server this credential authenticates against. - `Type BetaManagedAgentsStaticBearerCreateParamsType` - `const BetaManagedAgentsStaticBearerCreateParamsTypeStaticBearer BetaManagedAgentsStaticBearerCreateParamsType = "static_bearer"` ### Beta Managed Agents Static Bearer Update Params - `type BetaManagedAgentsStaticBearerUpdateParamsResp struct{…}` Parameters for updating a static bearer token credential. The `mcp_server_url` is immutable. - `Type BetaManagedAgentsStaticBearerUpdateParamsType` - `const BetaManagedAgentsStaticBearerUpdateParamsTypeStaticBearer BetaManagedAgentsStaticBearerUpdateParamsType = "static_bearer"` - `Token string` Updated static bearer token value. ### Beta Managed Agents Token Endpoint Auth Basic Param - `type BetaManagedAgentsTokenEndpointAuthBasicParamResp struct{…}` Token endpoint uses HTTP Basic authentication with client credentials. - `ClientSecret string` OAuth client secret. - `Type BetaManagedAgentsTokenEndpointAuthBasicParamType` - `const BetaManagedAgentsTokenEndpointAuthBasicParamTypeClientSecretBasic BetaManagedAgentsTokenEndpointAuthBasicParamType = "client_secret_basic"` ### Beta Managed Agents Token Endpoint Auth Basic Response - `type BetaManagedAgentsTokenEndpointAuthBasicResponse struct{…}` Token endpoint uses HTTP Basic authentication with client credentials. - `Type BetaManagedAgentsTokenEndpointAuthBasicResponseType` - `const BetaManagedAgentsTokenEndpointAuthBasicResponseTypeClientSecretBasic BetaManagedAgentsTokenEndpointAuthBasicResponseType = "client_secret_basic"` ### Beta Managed Agents Token Endpoint Auth Basic Update Param - `type BetaManagedAgentsTokenEndpointAuthBasicUpdateParamResp struct{…}` Updated HTTP Basic authentication parameters for the token endpoint. - `Type BetaManagedAgentsTokenEndpointAuthBasicUpdateParamType` - `const BetaManagedAgentsTokenEndpointAuthBasicUpdateParamTypeClientSecretBasic BetaManagedAgentsTokenEndpointAuthBasicUpdateParamType = "client_secret_basic"` - `ClientSecret string` Updated OAuth client secret. ### Beta Managed Agents Token Endpoint Auth None Param - `type BetaManagedAgentsTokenEndpointAuthNoneParamResp struct{…}` Token endpoint requires no client authentication. - `Type BetaManagedAgentsTokenEndpointAuthNoneParamType` - `const BetaManagedAgentsTokenEndpointAuthNoneParamTypeNone BetaManagedAgentsTokenEndpointAuthNoneParamType = "none"` ### Beta Managed Agents Token Endpoint Auth None Response - `type BetaManagedAgentsTokenEndpointAuthNoneResponse struct{…}` Token endpoint requires no client authentication. - `Type BetaManagedAgentsTokenEndpointAuthNoneResponseType` - `const BetaManagedAgentsTokenEndpointAuthNoneResponseTypeNone BetaManagedAgentsTokenEndpointAuthNoneResponseType = "none"` ### Beta Managed Agents Token Endpoint Auth Post Param - `type BetaManagedAgentsTokenEndpointAuthPostParamResp struct{…}` Token endpoint uses POST body authentication with client credentials. - `ClientSecret string` OAuth client secret. - `Type BetaManagedAgentsTokenEndpointAuthPostParamType` - `const BetaManagedAgentsTokenEndpointAuthPostParamTypeClientSecretPost BetaManagedAgentsTokenEndpointAuthPostParamType = "client_secret_post"` ### Beta Managed Agents Token Endpoint Auth Post Response - `type BetaManagedAgentsTokenEndpointAuthPostResponse struct{…}` Token endpoint uses POST body authentication with client credentials. - `Type BetaManagedAgentsTokenEndpointAuthPostResponseType` - `const BetaManagedAgentsTokenEndpointAuthPostResponseTypeClientSecretPost BetaManagedAgentsTokenEndpointAuthPostResponseType = "client_secret_post"` ### Beta Managed Agents Token Endpoint Auth Post Update Param - `type BetaManagedAgentsTokenEndpointAuthPostUpdateParamResp struct{…}` Updated POST body authentication parameters for the token endpoint. - `Type BetaManagedAgentsTokenEndpointAuthPostUpdateParamType` - `const BetaManagedAgentsTokenEndpointAuthPostUpdateParamTypeClientSecretPost BetaManagedAgentsTokenEndpointAuthPostUpdateParamType = "client_secret_post"` - `ClientSecret string` Updated OAuth client secret. # Memory Stores ## Create a memory store `client.Beta.MemoryStores.New(ctx, params) (*BetaManagedAgentsMemoryStore, error)` **post** `/v1/memory_stores` Create a memory store ### Parameters - `params BetaMemoryStoreNewParams` - `Name param.Field[string]` Body param: Human-readable name for the store. Required; 1–255 characters; no control characters. The mount-path slug under `/mnt/memory/` is derived from this name (lowercased, non-alphanumeric runs collapsed to a hyphen). Names need not be unique within a workspace. - `Description param.Field[string]` Body param: Free-text description of what the store contains, up to 1024 characters. Included in the agent's system prompt when the store is attached, so word it to be useful to the agent. - `Metadata param.Field[map[string, string]]` Body param: Arbitrary key-value tags for your own bookkeeping (such as the end user a store belongs to). Up to 16 pairs; keys 1–64 characters; values up to 512 characters. Not visible to the agent. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsMemoryStore struct{…}` A `memory_store`: a named container for agent memories, scoped to a workspace. Attach a store to a session via `resources[]` to mount it as a directory the agent can read and write. - `ID string` Unique identifier for the memory store (a `memstore_...` tagged ID). Use this when attaching the store to a session, or in the `{memory_store_id}` path parameter of subsequent calls. - `CreatedAt Time` A timestamp in RFC 3339 format - `Name string` Human-readable name for the store. 1–255 characters. The store's mount-path slug under `/mnt/memory/` is derived from this name. - `Type BetaManagedAgentsMemoryStoreType` - `const BetaManagedAgentsMemoryStoreTypeMemoryStore BetaManagedAgentsMemoryStoreType = "memory_store"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `ArchivedAt Time` A timestamp in RFC 3339 format - `Description string` Free-text description of what the store contains, up to 1024 characters. Included in the agent's system prompt when the store is attached, so word it to be useful to the agent. Empty string when unset. - `Metadata map[string, string]` Arbitrary key-value tags for your own bookkeeping (such as the end user a store belongs to). Up to 16 pairs; keys 1–64 characters; values up to 512 characters. Returned on retrieve/list but not filterable. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsMemoryStore, err := client.Beta.MemoryStores.New(context.TODO(), anthropic.BetaMemoryStoreNewParams{ Name: "x", }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsMemoryStore.ID) } ``` #### Response ```json { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "name": "name", "type": "memory_store", "updated_at": "2019-12-27T18:11:19.117Z", "archived_at": "2019-12-27T18:11:19.117Z", "description": "description", "metadata": { "foo": "string" } } ``` ## List memory stores `client.Beta.MemoryStores.List(ctx, params) (*PageCursor[BetaManagedAgentsMemoryStore], error)` **get** `/v1/memory_stores` List memory stores ### Parameters - `params BetaMemoryStoreListParams` - `CreatedAtGte param.Field[Time]` Query param: Return only stores whose `created_at` is at or after this time (inclusive). Sent on the wire as `created_at[gte]`. - `CreatedAtLte param.Field[Time]` Query param: Return only stores whose `created_at` is at or before this time (inclusive). Sent on the wire as `created_at[lte]`. - `IncludeArchived param.Field[bool]` Query param: When `true`, archived stores are included in the results. Defaults to `false` (archived stores are excluded). - `Limit param.Field[int64]` Query param: Maximum number of stores to return per page. Must be between 1 and 100. Defaults to 20 when omitted. - `Page param.Field[string]` Query param: Opaque pagination cursor (a `page_...` value). Pass the `next_page` value from a previous response to fetch the next page; omit for the first page. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsMemoryStore struct{…}` A `memory_store`: a named container for agent memories, scoped to a workspace. Attach a store to a session via `resources[]` to mount it as a directory the agent can read and write. - `ID string` Unique identifier for the memory store (a `memstore_...` tagged ID). Use this when attaching the store to a session, or in the `{memory_store_id}` path parameter of subsequent calls. - `CreatedAt Time` A timestamp in RFC 3339 format - `Name string` Human-readable name for the store. 1–255 characters. The store's mount-path slug under `/mnt/memory/` is derived from this name. - `Type BetaManagedAgentsMemoryStoreType` - `const BetaManagedAgentsMemoryStoreTypeMemoryStore BetaManagedAgentsMemoryStoreType = "memory_store"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `ArchivedAt Time` A timestamp in RFC 3339 format - `Description string` Free-text description of what the store contains, up to 1024 characters. Included in the agent's system prompt when the store is attached, so word it to be useful to the agent. Empty string when unset. - `Metadata map[string, string]` Arbitrary key-value tags for your own bookkeeping (such as the end user a store belongs to). Up to 16 pairs; keys 1–64 characters; values up to 512 characters. Returned on retrieve/list but not filterable. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) page, err := client.Beta.MemoryStores.List(context.TODO(), anthropic.BetaMemoryStoreListParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "data": [ { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "name": "name", "type": "memory_store", "updated_at": "2019-12-27T18:11:19.117Z", "archived_at": "2019-12-27T18:11:19.117Z", "description": "description", "metadata": { "foo": "string" } } ], "next_page": "next_page" } ``` ## Retrieve a memory store `client.Beta.MemoryStores.Get(ctx, memoryStoreID, query) (*BetaManagedAgentsMemoryStore, error)` **get** `/v1/memory_stores/{memory_store_id}` Retrieve a memory store ### Parameters - `memoryStoreID string` - `query BetaMemoryStoreGetParams` - `Betas param.Field[[]AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsMemoryStore struct{…}` A `memory_store`: a named container for agent memories, scoped to a workspace. Attach a store to a session via `resources[]` to mount it as a directory the agent can read and write. - `ID string` Unique identifier for the memory store (a `memstore_...` tagged ID). Use this when attaching the store to a session, or in the `{memory_store_id}` path parameter of subsequent calls. - `CreatedAt Time` A timestamp in RFC 3339 format - `Name string` Human-readable name for the store. 1–255 characters. The store's mount-path slug under `/mnt/memory/` is derived from this name. - `Type BetaManagedAgentsMemoryStoreType` - `const BetaManagedAgentsMemoryStoreTypeMemoryStore BetaManagedAgentsMemoryStoreType = "memory_store"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `ArchivedAt Time` A timestamp in RFC 3339 format - `Description string` Free-text description of what the store contains, up to 1024 characters. Included in the agent's system prompt when the store is attached, so word it to be useful to the agent. Empty string when unset. - `Metadata map[string, string]` Arbitrary key-value tags for your own bookkeeping (such as the end user a store belongs to). Up to 16 pairs; keys 1–64 characters; values up to 512 characters. Returned on retrieve/list but not filterable. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsMemoryStore, err := client.Beta.MemoryStores.Get( context.TODO(), "memory_store_id", anthropic.BetaMemoryStoreGetParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsMemoryStore.ID) } ``` #### Response ```json { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "name": "name", "type": "memory_store", "updated_at": "2019-12-27T18:11:19.117Z", "archived_at": "2019-12-27T18:11:19.117Z", "description": "description", "metadata": { "foo": "string" } } ``` ## Update a memory store `client.Beta.MemoryStores.Update(ctx, memoryStoreID, params) (*BetaManagedAgentsMemoryStore, error)` **post** `/v1/memory_stores/{memory_store_id}` Update a memory store ### Parameters - `memoryStoreID string` - `params BetaMemoryStoreUpdateParams` - `Description param.Field[string]` Body param: New description for the store, up to 1024 characters. Pass an empty string to clear it. - `Metadata param.Field[map[string, string]]` Body param: Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve. The stored bag is limited to 16 keys (up to 64 chars each) with values up to 512 chars. - `Name param.Field[string]` Body param: New human-readable name for the store. 1–255 characters; no control characters. Renaming changes the slug used for the store's `mount_path` in sessions created after the update. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsMemoryStore struct{…}` A `memory_store`: a named container for agent memories, scoped to a workspace. Attach a store to a session via `resources[]` to mount it as a directory the agent can read and write. - `ID string` Unique identifier for the memory store (a `memstore_...` tagged ID). Use this when attaching the store to a session, or in the `{memory_store_id}` path parameter of subsequent calls. - `CreatedAt Time` A timestamp in RFC 3339 format - `Name string` Human-readable name for the store. 1–255 characters. The store's mount-path slug under `/mnt/memory/` is derived from this name. - `Type BetaManagedAgentsMemoryStoreType` - `const BetaManagedAgentsMemoryStoreTypeMemoryStore BetaManagedAgentsMemoryStoreType = "memory_store"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `ArchivedAt Time` A timestamp in RFC 3339 format - `Description string` Free-text description of what the store contains, up to 1024 characters. Included in the agent's system prompt when the store is attached, so word it to be useful to the agent. Empty string when unset. - `Metadata map[string, string]` Arbitrary key-value tags for your own bookkeeping (such as the end user a store belongs to). Up to 16 pairs; keys 1–64 characters; values up to 512 characters. Returned on retrieve/list but not filterable. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsMemoryStore, err := client.Beta.MemoryStores.Update( context.TODO(), "memory_store_id", anthropic.BetaMemoryStoreUpdateParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsMemoryStore.ID) } ``` #### Response ```json { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "name": "name", "type": "memory_store", "updated_at": "2019-12-27T18:11:19.117Z", "archived_at": "2019-12-27T18:11:19.117Z", "description": "description", "metadata": { "foo": "string" } } ``` ## Delete a memory store `client.Beta.MemoryStores.Delete(ctx, memoryStoreID, body) (*BetaManagedAgentsDeletedMemoryStore, error)` **delete** `/v1/memory_stores/{memory_store_id}` Delete a memory store ### Parameters - `memoryStoreID string` - `body BetaMemoryStoreDeleteParams` - `Betas param.Field[[]AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsDeletedMemoryStore struct{…}` Confirmation that a `memory_store` was deleted. - `ID string` ID of the deleted memory store (a `memstore_...` identifier). The store and all its memories and versions are no longer retrievable. - `Type BetaManagedAgentsDeletedMemoryStoreType` - `const BetaManagedAgentsDeletedMemoryStoreTypeMemoryStoreDeleted BetaManagedAgentsDeletedMemoryStoreType = "memory_store_deleted"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsDeletedMemoryStore, err := client.Beta.MemoryStores.Delete( context.TODO(), "memory_store_id", anthropic.BetaMemoryStoreDeleteParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsDeletedMemoryStore.ID) } ``` #### Response ```json { "id": "id", "type": "memory_store_deleted" } ``` ## Archive a memory store `client.Beta.MemoryStores.Archive(ctx, memoryStoreID, body) (*BetaManagedAgentsMemoryStore, error)` **post** `/v1/memory_stores/{memory_store_id}/archive` Archive a memory store ### Parameters - `memoryStoreID string` - `body BetaMemoryStoreArchiveParams` - `Betas param.Field[[]AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsMemoryStore struct{…}` A `memory_store`: a named container for agent memories, scoped to a workspace. Attach a store to a session via `resources[]` to mount it as a directory the agent can read and write. - `ID string` Unique identifier for the memory store (a `memstore_...` tagged ID). Use this when attaching the store to a session, or in the `{memory_store_id}` path parameter of subsequent calls. - `CreatedAt Time` A timestamp in RFC 3339 format - `Name string` Human-readable name for the store. 1–255 characters. The store's mount-path slug under `/mnt/memory/` is derived from this name. - `Type BetaManagedAgentsMemoryStoreType` - `const BetaManagedAgentsMemoryStoreTypeMemoryStore BetaManagedAgentsMemoryStoreType = "memory_store"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `ArchivedAt Time` A timestamp in RFC 3339 format - `Description string` Free-text description of what the store contains, up to 1024 characters. Included in the agent's system prompt when the store is attached, so word it to be useful to the agent. Empty string when unset. - `Metadata map[string, string]` Arbitrary key-value tags for your own bookkeeping (such as the end user a store belongs to). Up to 16 pairs; keys 1–64 characters; values up to 512 characters. Returned on retrieve/list but not filterable. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsMemoryStore, err := client.Beta.MemoryStores.Archive( context.TODO(), "memory_store_id", anthropic.BetaMemoryStoreArchiveParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsMemoryStore.ID) } ``` #### Response ```json { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "name": "name", "type": "memory_store", "updated_at": "2019-12-27T18:11:19.117Z", "archived_at": "2019-12-27T18:11:19.117Z", "description": "description", "metadata": { "foo": "string" } } ``` ## Domain Types ### Beta Managed Agents Deleted Memory Store - `type BetaManagedAgentsDeletedMemoryStore struct{…}` Confirmation that a `memory_store` was deleted. - `ID string` ID of the deleted memory store (a `memstore_...` identifier). The store and all its memories and versions are no longer retrievable. - `Type BetaManagedAgentsDeletedMemoryStoreType` - `const BetaManagedAgentsDeletedMemoryStoreTypeMemoryStoreDeleted BetaManagedAgentsDeletedMemoryStoreType = "memory_store_deleted"` ### Beta Managed Agents Memory Store - `type BetaManagedAgentsMemoryStore struct{…}` A `memory_store`: a named container for agent memories, scoped to a workspace. Attach a store to a session via `resources[]` to mount it as a directory the agent can read and write. - `ID string` Unique identifier for the memory store (a `memstore_...` tagged ID). Use this when attaching the store to a session, or in the `{memory_store_id}` path parameter of subsequent calls. - `CreatedAt Time` A timestamp in RFC 3339 format - `Name string` Human-readable name for the store. 1–255 characters. The store's mount-path slug under `/mnt/memory/` is derived from this name. - `Type BetaManagedAgentsMemoryStoreType` - `const BetaManagedAgentsMemoryStoreTypeMemoryStore BetaManagedAgentsMemoryStoreType = "memory_store"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `ArchivedAt Time` A timestamp in RFC 3339 format - `Description string` Free-text description of what the store contains, up to 1024 characters. Included in the agent's system prompt when the store is attached, so word it to be useful to the agent. Empty string when unset. - `Metadata map[string, string]` Arbitrary key-value tags for your own bookkeeping (such as the end user a store belongs to). Up to 16 pairs; keys 1–64 characters; values up to 512 characters. Returned on retrieve/list but not filterable. # Memories ## Create a memory `client.Beta.MemoryStores.Memories.New(ctx, memoryStoreID, params) (*BetaManagedAgentsMemory, error)` **post** `/v1/memory_stores/{memory_store_id}/memories` Create a memory ### Parameters - `memoryStoreID string` - `params BetaMemoryStoreMemoryNewParams` - `Content param.Field[string]` Body param: UTF-8 text content for the new memory. Maximum 100 kB (102,400 bytes). Required; pass `""` explicitly to create an empty memory. - `Path param.Field[string]` Body param: Hierarchical path for the new memory, e.g. `/projects/foo/notes.md`. Must start with `/`, contain at least one non-empty segment, and be at most 1,024 bytes. Must not contain empty segments, `.` or `..` segments, control or format characters, and must be NFC-normalized. Paths are case-sensitive. - `View param.Field[BetaManagedAgentsMemoryView]` Query param: Query parameter for view - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsMemory struct{…}` A `memory` object: a single text document at a hierarchical path inside a memory store. The `content` field is populated when `view=full` and `null` when `view=basic`; the `content_size_bytes` and `content_sha256` fields are always populated so sync clients can diff without fetching content. Memories are addressed by their `mem_...` ID; the path is the create key and can be changed via update. - `ID string` Unique identifier for this memory (a `mem_...` value). Stable across renames; use this ID, not the path, to read, update, or delete the memory. - `ContentSha256 string` Lowercase hex SHA-256 digest of the UTF-8 `content` bytes (64 characters). The server applies no normalization, so clients can compute the same hash locally for staleness checks and as the value for a `content_sha256` precondition on update. Always populated, regardless of `view`. - `ContentSizeBytes int64` Size of `content` in bytes (the UTF-8 plaintext length). Always populated, regardless of `view`. - `CreatedAt Time` A timestamp in RFC 3339 format - `MemoryStoreID string` ID of the memory store this memory belongs to (a `memstore_...` value). - `MemoryVersionID string` ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `Path string` Hierarchical path of the memory within the store, e.g. `/projects/foo/notes.md`. Always starts with `/`. Paths are case-sensitive and unique within a store. Maximum 1,024 bytes. - `Type BetaManagedAgentsMemoryType` - `const BetaManagedAgentsMemoryTypeMemory BetaManagedAgentsMemoryType = "memory"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `Content string` The memory's UTF-8 text content. Populated when `view=full`; `null` when `view=basic`. Maximum 100 kB (102,400 bytes). ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsMemory, err := client.Beta.MemoryStores.Memories.New( context.TODO(), "memory_store_id", anthropic.BetaMemoryStoreMemoryNewParams{ Content: anthropic.String("content"), Path: "xx", }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsMemory.ID) } ``` #### Response ```json { "id": "id", "content_sha256": "content_sha256", "content_size_bytes": 0, "created_at": "2019-12-27T18:11:19.117Z", "memory_store_id": "memory_store_id", "memory_version_id": "memory_version_id", "path": "path", "type": "memory", "updated_at": "2019-12-27T18:11:19.117Z", "content": "content" } ``` ## List memories `client.Beta.MemoryStores.Memories.List(ctx, memoryStoreID, params) (*PageCursor[BetaManagedAgentsMemoryListItemUnion], error)` **get** `/v1/memory_stores/{memory_store_id}/memories` List memories ### Parameters - `memoryStoreID string` - `params BetaMemoryStoreMemoryListParams` - `Depth param.Field[int64]` Query param: Query parameter for depth - `Limit param.Field[int64]` Query param: Query parameter for limit - `Order param.Field[BetaMemoryStoreMemoryListParamsOrder]` Query param: Query parameter for order - `const BetaMemoryStoreMemoryListParamsOrderAsc BetaMemoryStoreMemoryListParamsOrder = "asc"` - `const BetaMemoryStoreMemoryListParamsOrderDesc BetaMemoryStoreMemoryListParamsOrder = "desc"` - `OrderBy param.Field[string]` Query param: Query parameter for order_by - `Page param.Field[string]` Query param: Query parameter for page - `PathPrefix param.Field[string]` Query param: Optional path prefix filter (raw string-prefix match; include a trailing slash for directory-scoped lists). This value appears in request URLs. Do not include secrets or personally identifiable information. - `View param.Field[BetaManagedAgentsMemoryView]` Query param: Query parameter for view - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsMemoryListItemUnion interface{…}` One item in a [List memories](/docs/en/api/beta/memory_stores/memories/list) response: either a `memory` object or, when `depth` is set, a `memory_prefix` rollup marker. - `type BetaManagedAgentsMemory struct{…}` A `memory` object: a single text document at a hierarchical path inside a memory store. The `content` field is populated when `view=full` and `null` when `view=basic`; the `content_size_bytes` and `content_sha256` fields are always populated so sync clients can diff without fetching content. Memories are addressed by their `mem_...` ID; the path is the create key and can be changed via update. - `ID string` Unique identifier for this memory (a `mem_...` value). Stable across renames; use this ID, not the path, to read, update, or delete the memory. - `ContentSha256 string` Lowercase hex SHA-256 digest of the UTF-8 `content` bytes (64 characters). The server applies no normalization, so clients can compute the same hash locally for staleness checks and as the value for a `content_sha256` precondition on update. Always populated, regardless of `view`. - `ContentSizeBytes int64` Size of `content` in bytes (the UTF-8 plaintext length). Always populated, regardless of `view`. - `CreatedAt Time` A timestamp in RFC 3339 format - `MemoryStoreID string` ID of the memory store this memory belongs to (a `memstore_...` value). - `MemoryVersionID string` ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `Path string` Hierarchical path of the memory within the store, e.g. `/projects/foo/notes.md`. Always starts with `/`. Paths are case-sensitive and unique within a store. Maximum 1,024 bytes. - `Type BetaManagedAgentsMemoryType` - `const BetaManagedAgentsMemoryTypeMemory BetaManagedAgentsMemoryType = "memory"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `Content string` The memory's UTF-8 text content. Populated when `view=full`; `null` when `view=basic`. Maximum 100 kB (102,400 bytes). - `type BetaManagedAgentsMemoryPrefix struct{…}` A rolled-up directory marker returned by [List memories](/docs/en/api/beta/memory_stores/memories/list) when `depth` is set. Indicates that one or more memories exist deeper than the requested depth under this prefix. This is a list-time rollup, not a stored resource; it has no ID and no lifecycle. Each prefix counts toward the page `limit` and interleaves with `memory` items in path order. - `Path string` The rolled-up path prefix, including a trailing `/` (e.g. `/projects/foo/`). Pass this value as `path_prefix` on a subsequent list call to drill into the directory. - `Type BetaManagedAgentsMemoryPrefixType` - `const BetaManagedAgentsMemoryPrefixTypeMemoryPrefix BetaManagedAgentsMemoryPrefixType = "memory_prefix"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) page, err := client.Beta.MemoryStores.Memories.List( context.TODO(), "memory_store_id", anthropic.BetaMemoryStoreMemoryListParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "data": [ { "id": "id", "content_sha256": "content_sha256", "content_size_bytes": 0, "created_at": "2019-12-27T18:11:19.117Z", "memory_store_id": "memory_store_id", "memory_version_id": "memory_version_id", "path": "path", "type": "memory", "updated_at": "2019-12-27T18:11:19.117Z", "content": "content" } ], "next_page": "next_page" } ``` ## Retrieve a memory `client.Beta.MemoryStores.Memories.Get(ctx, memoryID, params) (*BetaManagedAgentsMemory, error)` **get** `/v1/memory_stores/{memory_store_id}/memories/{memory_id}` Retrieve a memory ### Parameters - `memoryID string` - `params BetaMemoryStoreMemoryGetParams` - `MemoryStoreID param.Field[string]` Path param: Path parameter memory_store_id - `View param.Field[BetaManagedAgentsMemoryView]` Query param: Query parameter for view - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsMemory struct{…}` A `memory` object: a single text document at a hierarchical path inside a memory store. The `content` field is populated when `view=full` and `null` when `view=basic`; the `content_size_bytes` and `content_sha256` fields are always populated so sync clients can diff without fetching content. Memories are addressed by their `mem_...` ID; the path is the create key and can be changed via update. - `ID string` Unique identifier for this memory (a `mem_...` value). Stable across renames; use this ID, not the path, to read, update, or delete the memory. - `ContentSha256 string` Lowercase hex SHA-256 digest of the UTF-8 `content` bytes (64 characters). The server applies no normalization, so clients can compute the same hash locally for staleness checks and as the value for a `content_sha256` precondition on update. Always populated, regardless of `view`. - `ContentSizeBytes int64` Size of `content` in bytes (the UTF-8 plaintext length). Always populated, regardless of `view`. - `CreatedAt Time` A timestamp in RFC 3339 format - `MemoryStoreID string` ID of the memory store this memory belongs to (a `memstore_...` value). - `MemoryVersionID string` ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `Path string` Hierarchical path of the memory within the store, e.g. `/projects/foo/notes.md`. Always starts with `/`. Paths are case-sensitive and unique within a store. Maximum 1,024 bytes. - `Type BetaManagedAgentsMemoryType` - `const BetaManagedAgentsMemoryTypeMemory BetaManagedAgentsMemoryType = "memory"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `Content string` The memory's UTF-8 text content. Populated when `view=full`; `null` when `view=basic`. Maximum 100 kB (102,400 bytes). ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsMemory, err := client.Beta.MemoryStores.Memories.Get( context.TODO(), "memory_id", anthropic.BetaMemoryStoreMemoryGetParams{ MemoryStoreID: "memory_store_id", }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsMemory.ID) } ``` #### Response ```json { "id": "id", "content_sha256": "content_sha256", "content_size_bytes": 0, "created_at": "2019-12-27T18:11:19.117Z", "memory_store_id": "memory_store_id", "memory_version_id": "memory_version_id", "path": "path", "type": "memory", "updated_at": "2019-12-27T18:11:19.117Z", "content": "content" } ``` ## Update a memory `client.Beta.MemoryStores.Memories.Update(ctx, memoryID, params) (*BetaManagedAgentsMemory, error)` **post** `/v1/memory_stores/{memory_store_id}/memories/{memory_id}` Update a memory ### Parameters - `memoryID string` - `params BetaMemoryStoreMemoryUpdateParams` - `MemoryStoreID param.Field[string]` Path param: Path parameter memory_store_id - `View param.Field[BetaManagedAgentsMemoryView]` Query param: Query parameter for view - `Content param.Field[string]` Body param: New UTF-8 text content for the memory. Maximum 100 kB (102,400 bytes). Omit to leave the content unchanged (e.g., for a rename-only update). - `Path param.Field[string]` Body param: New path for the memory (a rename). Must start with `/`, contain at least one non-empty segment, and be at most 1,024 bytes. Must not contain empty segments, `.` or `..` segments, control or format characters, and must be NFC-normalized. Paths are case-sensitive. The memory's `id` is preserved across renames. Omit to leave the path unchanged. - `Precondition param.Field[BetaManagedAgentsPrecondition]` Body param: Optimistic-concurrency precondition: the update applies only if the memory's stored `content_sha256` equals the supplied value. On mismatch, the request returns `memory_precondition_failed_error` (HTTP 409); re-read the memory and retry against the fresh state. If the precondition fails but the stored state already exactly matches the requested `content` and `path`, the server returns 200 instead of 409. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsMemory struct{…}` A `memory` object: a single text document at a hierarchical path inside a memory store. The `content` field is populated when `view=full` and `null` when `view=basic`; the `content_size_bytes` and `content_sha256` fields are always populated so sync clients can diff without fetching content. Memories are addressed by their `mem_...` ID; the path is the create key and can be changed via update. - `ID string` Unique identifier for this memory (a `mem_...` value). Stable across renames; use this ID, not the path, to read, update, or delete the memory. - `ContentSha256 string` Lowercase hex SHA-256 digest of the UTF-8 `content` bytes (64 characters). The server applies no normalization, so clients can compute the same hash locally for staleness checks and as the value for a `content_sha256` precondition on update. Always populated, regardless of `view`. - `ContentSizeBytes int64` Size of `content` in bytes (the UTF-8 plaintext length). Always populated, regardless of `view`. - `CreatedAt Time` A timestamp in RFC 3339 format - `MemoryStoreID string` ID of the memory store this memory belongs to (a `memstore_...` value). - `MemoryVersionID string` ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `Path string` Hierarchical path of the memory within the store, e.g. `/projects/foo/notes.md`. Always starts with `/`. Paths are case-sensitive and unique within a store. Maximum 1,024 bytes. - `Type BetaManagedAgentsMemoryType` - `const BetaManagedAgentsMemoryTypeMemory BetaManagedAgentsMemoryType = "memory"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `Content string` The memory's UTF-8 text content. Populated when `view=full`; `null` when `view=basic`. Maximum 100 kB (102,400 bytes). ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsMemory, err := client.Beta.MemoryStores.Memories.Update( context.TODO(), "memory_id", anthropic.BetaMemoryStoreMemoryUpdateParams{ MemoryStoreID: "memory_store_id", }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsMemory.ID) } ``` #### Response ```json { "id": "id", "content_sha256": "content_sha256", "content_size_bytes": 0, "created_at": "2019-12-27T18:11:19.117Z", "memory_store_id": "memory_store_id", "memory_version_id": "memory_version_id", "path": "path", "type": "memory", "updated_at": "2019-12-27T18:11:19.117Z", "content": "content" } ``` ## Delete a memory `client.Beta.MemoryStores.Memories.Delete(ctx, memoryID, params) (*BetaManagedAgentsDeletedMemory, error)` **delete** `/v1/memory_stores/{memory_store_id}/memories/{memory_id}` Delete a memory ### Parameters - `memoryID string` - `params BetaMemoryStoreMemoryDeleteParams` - `MemoryStoreID param.Field[string]` Path param: Path parameter memory_store_id - `ExpectedContentSha256 param.Field[string]` Query param: Query parameter for expected_content_sha256 - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsDeletedMemory struct{…}` Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. - `ID string` ID of the deleted memory (a `mem_...` value). - `Type BetaManagedAgentsDeletedMemoryType` - `const BetaManagedAgentsDeletedMemoryTypeMemoryDeleted BetaManagedAgentsDeletedMemoryType = "memory_deleted"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsDeletedMemory, err := client.Beta.MemoryStores.Memories.Delete( context.TODO(), "memory_id", anthropic.BetaMemoryStoreMemoryDeleteParams{ MemoryStoreID: "memory_store_id", }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsDeletedMemory.ID) } ``` #### Response ```json { "id": "id", "type": "memory_deleted" } ``` ## Domain Types ### Beta Managed Agents Conflict Error - `type BetaManagedAgentsConflictError struct{…}` - `Type BetaManagedAgentsConflictErrorType` - `const BetaManagedAgentsConflictErrorTypeConflictError BetaManagedAgentsConflictErrorType = "conflict_error"` - `Message string` ### Beta Managed Agents Content Sha256 Precondition - `type BetaManagedAgentsContentSha256Precondition struct{…}` Optimistic-concurrency precondition: the update applies only if the memory's stored `content_sha256` equals the supplied value. On mismatch, the request returns `memory_precondition_failed_error` (HTTP 409); re-read the memory and retry against the fresh state. If the precondition fails but the stored state already exactly matches the requested `content` and `path`, the server returns 200 instead of 409. - `Type BetaManagedAgentsContentSha256PreconditionType` - `const BetaManagedAgentsContentSha256PreconditionTypeContentSha256 BetaManagedAgentsContentSha256PreconditionType = "content_sha256"` - `ContentSha256 string` Expected `content_sha256` of the stored memory (64 lowercase hexadecimal characters). Typically the `content_sha256` returned by a prior read or list call. Because the server applies no content normalization, clients can also compute this locally as the SHA-256 of the UTF-8 content bytes. ### Beta Managed Agents Deleted Memory - `type BetaManagedAgentsDeletedMemory struct{…}` Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. - `ID string` ID of the deleted memory (a `mem_...` value). - `Type BetaManagedAgentsDeletedMemoryType` - `const BetaManagedAgentsDeletedMemoryTypeMemoryDeleted BetaManagedAgentsDeletedMemoryType = "memory_deleted"` ### Beta Managed Agents Error - `type BetaManagedAgentsErrorUnion interface{…}` - `type BetaInvalidRequestError struct{…}` - `Message string` - `Type InvalidRequestError` - `const InvalidRequestErrorInvalidRequestError InvalidRequestError = "invalid_request_error"` - `type BetaAuthenticationError struct{…}` - `Message string` - `Type AuthenticationError` - `const AuthenticationErrorAuthenticationError AuthenticationError = "authentication_error"` - `type BetaBillingError struct{…}` - `Message string` - `Type BillingError` - `const BillingErrorBillingError BillingError = "billing_error"` - `type BetaPermissionError struct{…}` - `Message string` - `Type PermissionError` - `const PermissionErrorPermissionError PermissionError = "permission_error"` - `type BetaNotFoundError struct{…}` - `Message string` - `Type NotFoundError` - `const NotFoundErrorNotFoundError NotFoundError = "not_found_error"` - `type BetaRateLimitError struct{…}` - `Message string` - `Type RateLimitError` - `const RateLimitErrorRateLimitError RateLimitError = "rate_limit_error"` - `type BetaGatewayTimeoutError struct{…}` - `Message string` - `Type TimeoutError` - `const TimeoutErrorTimeoutError TimeoutError = "timeout_error"` - `type BetaAPIError struct{…}` - `Message string` - `Type APIError` - `const APIErrorAPIError APIError = "api_error"` - `type BetaOverloadedError struct{…}` - `Message string` - `Type OverloadedError` - `const OverloadedErrorOverloadedError OverloadedError = "overloaded_error"` - `type BetaManagedAgentsMemoryPreconditionFailedError struct{…}` - `Type BetaManagedAgentsMemoryPreconditionFailedErrorType` - `const BetaManagedAgentsMemoryPreconditionFailedErrorTypeMemoryPreconditionFailedError BetaManagedAgentsMemoryPreconditionFailedErrorType = "memory_precondition_failed_error"` - `Message string` - `type BetaManagedAgentsMemoryPathConflictError struct{…}` - `Type BetaManagedAgentsMemoryPathConflictErrorType` - `const BetaManagedAgentsMemoryPathConflictErrorTypeMemoryPathConflictError BetaManagedAgentsMemoryPathConflictErrorType = "memory_path_conflict_error"` - `ConflictingMemoryID string` - `ConflictingPath string` - `Message string` - `type BetaManagedAgentsConflictError struct{…}` - `Type BetaManagedAgentsConflictErrorType` - `const BetaManagedAgentsConflictErrorTypeConflictError BetaManagedAgentsConflictErrorType = "conflict_error"` - `Message string` ### Beta Managed Agents Memory - `type BetaManagedAgentsMemory struct{…}` A `memory` object: a single text document at a hierarchical path inside a memory store. The `content` field is populated when `view=full` and `null` when `view=basic`; the `content_size_bytes` and `content_sha256` fields are always populated so sync clients can diff without fetching content. Memories are addressed by their `mem_...` ID; the path is the create key and can be changed via update. - `ID string` Unique identifier for this memory (a `mem_...` value). Stable across renames; use this ID, not the path, to read, update, or delete the memory. - `ContentSha256 string` Lowercase hex SHA-256 digest of the UTF-8 `content` bytes (64 characters). The server applies no normalization, so clients can compute the same hash locally for staleness checks and as the value for a `content_sha256` precondition on update. Always populated, regardless of `view`. - `ContentSizeBytes int64` Size of `content` in bytes (the UTF-8 plaintext length). Always populated, regardless of `view`. - `CreatedAt Time` A timestamp in RFC 3339 format - `MemoryStoreID string` ID of the memory store this memory belongs to (a `memstore_...` value). - `MemoryVersionID string` ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `Path string` Hierarchical path of the memory within the store, e.g. `/projects/foo/notes.md`. Always starts with `/`. Paths are case-sensitive and unique within a store. Maximum 1,024 bytes. - `Type BetaManagedAgentsMemoryType` - `const BetaManagedAgentsMemoryTypeMemory BetaManagedAgentsMemoryType = "memory"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `Content string` The memory's UTF-8 text content. Populated when `view=full`; `null` when `view=basic`. Maximum 100 kB (102,400 bytes). ### Beta Managed Agents Memory List Item - `type BetaManagedAgentsMemoryListItemUnion interface{…}` One item in a [List memories](/docs/en/api/beta/memory_stores/memories/list) response: either a `memory` object or, when `depth` is set, a `memory_prefix` rollup marker. - `type BetaManagedAgentsMemory struct{…}` A `memory` object: a single text document at a hierarchical path inside a memory store. The `content` field is populated when `view=full` and `null` when `view=basic`; the `content_size_bytes` and `content_sha256` fields are always populated so sync clients can diff without fetching content. Memories are addressed by their `mem_...` ID; the path is the create key and can be changed via update. - `ID string` Unique identifier for this memory (a `mem_...` value). Stable across renames; use this ID, not the path, to read, update, or delete the memory. - `ContentSha256 string` Lowercase hex SHA-256 digest of the UTF-8 `content` bytes (64 characters). The server applies no normalization, so clients can compute the same hash locally for staleness checks and as the value for a `content_sha256` precondition on update. Always populated, regardless of `view`. - `ContentSizeBytes int64` Size of `content` in bytes (the UTF-8 plaintext length). Always populated, regardless of `view`. - `CreatedAt Time` A timestamp in RFC 3339 format - `MemoryStoreID string` ID of the memory store this memory belongs to (a `memstore_...` value). - `MemoryVersionID string` ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `Path string` Hierarchical path of the memory within the store, e.g. `/projects/foo/notes.md`. Always starts with `/`. Paths are case-sensitive and unique within a store. Maximum 1,024 bytes. - `Type BetaManagedAgentsMemoryType` - `const BetaManagedAgentsMemoryTypeMemory BetaManagedAgentsMemoryType = "memory"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `Content string` The memory's UTF-8 text content. Populated when `view=full`; `null` when `view=basic`. Maximum 100 kB (102,400 bytes). - `type BetaManagedAgentsMemoryPrefix struct{…}` A rolled-up directory marker returned by [List memories](/docs/en/api/beta/memory_stores/memories/list) when `depth` is set. Indicates that one or more memories exist deeper than the requested depth under this prefix. This is a list-time rollup, not a stored resource; it has no ID and no lifecycle. Each prefix counts toward the page `limit` and interleaves with `memory` items in path order. - `Path string` The rolled-up path prefix, including a trailing `/` (e.g. `/projects/foo/`). Pass this value as `path_prefix` on a subsequent list call to drill into the directory. - `Type BetaManagedAgentsMemoryPrefixType` - `const BetaManagedAgentsMemoryPrefixTypeMemoryPrefix BetaManagedAgentsMemoryPrefixType = "memory_prefix"` ### Beta Managed Agents Memory Path Conflict Error - `type BetaManagedAgentsMemoryPathConflictError struct{…}` - `Type BetaManagedAgentsMemoryPathConflictErrorType` - `const BetaManagedAgentsMemoryPathConflictErrorTypeMemoryPathConflictError BetaManagedAgentsMemoryPathConflictErrorType = "memory_path_conflict_error"` - `ConflictingMemoryID string` - `ConflictingPath string` - `Message string` ### Beta Managed Agents Memory Precondition Failed Error - `type BetaManagedAgentsMemoryPreconditionFailedError struct{…}` - `Type BetaManagedAgentsMemoryPreconditionFailedErrorType` - `const BetaManagedAgentsMemoryPreconditionFailedErrorTypeMemoryPreconditionFailedError BetaManagedAgentsMemoryPreconditionFailedErrorType = "memory_precondition_failed_error"` - `Message string` ### Beta Managed Agents Memory Prefix - `type BetaManagedAgentsMemoryPrefix struct{…}` A rolled-up directory marker returned by [List memories](/docs/en/api/beta/memory_stores/memories/list) when `depth` is set. Indicates that one or more memories exist deeper than the requested depth under this prefix. This is a list-time rollup, not a stored resource; it has no ID and no lifecycle. Each prefix counts toward the page `limit` and interleaves with `memory` items in path order. - `Path string` The rolled-up path prefix, including a trailing `/` (e.g. `/projects/foo/`). Pass this value as `path_prefix` on a subsequent list call to drill into the directory. - `Type BetaManagedAgentsMemoryPrefixType` - `const BetaManagedAgentsMemoryPrefixTypeMemoryPrefix BetaManagedAgentsMemoryPrefixType = "memory_prefix"` ### Beta Managed Agents Memory View - `type BetaManagedAgentsMemoryView string` Selects which projection of a `memory` or `memory_version` the server returns. `basic` returns the object with `content` set to `null`; `full` populates `content`. When omitted, the default is endpoint-specific: retrieve operations default to `full`; list, create, and update operations default to `basic`. Listing with `view=full` caps `limit` at 20. - `const BetaManagedAgentsMemoryViewBasic BetaManagedAgentsMemoryView = "basic"` - `const BetaManagedAgentsMemoryViewFull BetaManagedAgentsMemoryView = "full"` ### Beta Managed Agents Precondition - `type BetaManagedAgentsPrecondition struct{…}` Optimistic-concurrency precondition: the update applies only if the memory's stored `content_sha256` equals the supplied value. On mismatch, the request returns `memory_precondition_failed_error` (HTTP 409); re-read the memory and retry against the fresh state. If the precondition fails but the stored state already exactly matches the requested `content` and `path`, the server returns 200 instead of 409. - `Type BetaManagedAgentsPreconditionType` - `const BetaManagedAgentsPreconditionTypeContentSha256 BetaManagedAgentsPreconditionType = "content_sha256"` - `ContentSha256 string` Expected `content_sha256` of the stored memory (64 lowercase hexadecimal characters). Typically the `content_sha256` returned by a prior read or list call. Because the server applies no content normalization, clients can also compute this locally as the SHA-256 of the UTF-8 content bytes. # Memory Versions ## List memory versions `client.Beta.MemoryStores.MemoryVersions.List(ctx, memoryStoreID, params) (*PageCursor[BetaManagedAgentsMemoryVersion], error)` **get** `/v1/memory_stores/{memory_store_id}/memory_versions` List memory versions ### Parameters - `memoryStoreID string` - `params BetaMemoryStoreMemoryVersionListParams` - `APIKeyID param.Field[string]` Query param: Query parameter for api_key_id - `CreatedAtGte param.Field[Time]` Query param: Return versions created at or after this time (inclusive). - `CreatedAtLte param.Field[Time]` Query param: Return versions created at or before this time (inclusive). - `Limit param.Field[int64]` Query param: Query parameter for limit - `MemoryID param.Field[string]` Query param: Query parameter for memory_id - `Operation param.Field[BetaManagedAgentsMemoryVersionOperation]` Query param: Query parameter for operation - `Page param.Field[string]` Query param: Query parameter for page - `SessionID param.Field[string]` Query param: Query parameter for session_id - `View param.Field[BetaManagedAgentsMemoryView]` Query param: Query parameter for view - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsMemoryVersion struct{…}` A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `ID string` Unique identifier for this version (a `memver_...` value). - `CreatedAt Time` A timestamp in RFC 3339 format - `MemoryID string` ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. - `MemoryStoreID string` ID of the memory store this version belongs to (a `memstore_...` value). - `Operation BetaManagedAgentsMemoryVersionOperation` The kind of mutation a `memory_version` records. Every non-no-op mutation to a memory appends exactly one version row with one of these values. - `const BetaManagedAgentsMemoryVersionOperationCreated BetaManagedAgentsMemoryVersionOperation = "created"` - `const BetaManagedAgentsMemoryVersionOperationModified BetaManagedAgentsMemoryVersionOperation = "modified"` - `const BetaManagedAgentsMemoryVersionOperationDeleted BetaManagedAgentsMemoryVersionOperation = "deleted"` - `Type BetaManagedAgentsMemoryVersionType` - `const BetaManagedAgentsMemoryVersionTypeMemoryVersion BetaManagedAgentsMemoryVersionType = "memory_version"` - `Content string` The memory's UTF-8 text content as of this version. `null` when `view=basic`, when `operation` is `deleted`, or when `redacted_at` is set. - `ContentSha256 string` Lowercase hex SHA-256 digest of `content` as of this version (64 characters). `null` when `redacted_at` is set or `operation` is `deleted`. Populated regardless of `view` otherwise. - `ContentSizeBytes int64` Size of `content` in bytes as of this version. `null` when `redacted_at` is set or `operation` is `deleted`. Populated regardless of `view` otherwise. - `CreatedBy BetaManagedAgentsActorUnion` Identifies who performed a write or redact operation. Captured at write time on the `memory_version` row. The API key that created a session is not recorded on agent writes; attribution answers who made the write, not who is ultimately responsible. Look up session provenance separately via the [Sessions API](/docs/en/api/sessions-retrieve). - `type BetaManagedAgentsSessionActor struct{…}` Attribution for a write made by an agent during a session, through the mounted filesystem at `/mnt/memory/`. - `SessionID string` ID of the session that performed the write (a `sesn_...` value). Look up the session via [Retrieve a session](/docs/en/api/sessions-retrieve) for further provenance. - `Type BetaManagedAgentsSessionActorType` - `const BetaManagedAgentsSessionActorTypeSessionActor BetaManagedAgentsSessionActorType = "session_actor"` - `type BetaManagedAgentsAPIActor struct{…}` Attribution for a write made directly via the public API (outside of any session). - `APIKeyID string` ID of the API key that performed the write. This identifies the key, not the secret. - `Type BetaManagedAgentsAPIActorType` - `const BetaManagedAgentsAPIActorTypeAPIActor BetaManagedAgentsAPIActorType = "api_actor"` - `type BetaManagedAgentsUserActor struct{…}` Attribution for a write made by a human user through the Anthropic Console. - `Type BetaManagedAgentsUserActorType` - `const BetaManagedAgentsUserActorTypeUserActor BetaManagedAgentsUserActorType = "user_actor"` - `UserID string` ID of the user who performed the write (a `user_...` value). - `Path string` The memory's path at the time of this write. `null` if and only if `redacted_at` is set. - `RedactedAt Time` A timestamp in RFC 3339 format - `RedactedBy BetaManagedAgentsActorUnion` Identifies who performed a write or redact operation. Captured at write time on the `memory_version` row. The API key that created a session is not recorded on agent writes; attribution answers who made the write, not who is ultimately responsible. Look up session provenance separately via the [Sessions API](/docs/en/api/sessions-retrieve). ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) page, err := client.Beta.MemoryStores.MemoryVersions.List( context.TODO(), "memory_store_id", anthropic.BetaMemoryStoreMemoryVersionListParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "data": [ { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "memory_id": "memory_id", "memory_store_id": "memory_store_id", "operation": "created", "type": "memory_version", "content": "content", "content_sha256": "content_sha256", "content_size_bytes": 0, "created_by": { "session_id": "x", "type": "session_actor" }, "path": "path", "redacted_at": "2019-12-27T18:11:19.117Z", "redacted_by": { "session_id": "x", "type": "session_actor" } } ], "next_page": "next_page" } ``` ## Retrieve a memory version `client.Beta.MemoryStores.MemoryVersions.Get(ctx, memoryVersionID, params) (*BetaManagedAgentsMemoryVersion, error)` **get** `/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}` Retrieve a memory version ### Parameters - `memoryVersionID string` - `params BetaMemoryStoreMemoryVersionGetParams` - `MemoryStoreID param.Field[string]` Path param: Path parameter memory_store_id - `View param.Field[BetaManagedAgentsMemoryView]` Query param: Query parameter for view - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsMemoryVersion struct{…}` A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `ID string` Unique identifier for this version (a `memver_...` value). - `CreatedAt Time` A timestamp in RFC 3339 format - `MemoryID string` ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. - `MemoryStoreID string` ID of the memory store this version belongs to (a `memstore_...` value). - `Operation BetaManagedAgentsMemoryVersionOperation` The kind of mutation a `memory_version` records. Every non-no-op mutation to a memory appends exactly one version row with one of these values. - `const BetaManagedAgentsMemoryVersionOperationCreated BetaManagedAgentsMemoryVersionOperation = "created"` - `const BetaManagedAgentsMemoryVersionOperationModified BetaManagedAgentsMemoryVersionOperation = "modified"` - `const BetaManagedAgentsMemoryVersionOperationDeleted BetaManagedAgentsMemoryVersionOperation = "deleted"` - `Type BetaManagedAgentsMemoryVersionType` - `const BetaManagedAgentsMemoryVersionTypeMemoryVersion BetaManagedAgentsMemoryVersionType = "memory_version"` - `Content string` The memory's UTF-8 text content as of this version. `null` when `view=basic`, when `operation` is `deleted`, or when `redacted_at` is set. - `ContentSha256 string` Lowercase hex SHA-256 digest of `content` as of this version (64 characters). `null` when `redacted_at` is set or `operation` is `deleted`. Populated regardless of `view` otherwise. - `ContentSizeBytes int64` Size of `content` in bytes as of this version. `null` when `redacted_at` is set or `operation` is `deleted`. Populated regardless of `view` otherwise. - `CreatedBy BetaManagedAgentsActorUnion` Identifies who performed a write or redact operation. Captured at write time on the `memory_version` row. The API key that created a session is not recorded on agent writes; attribution answers who made the write, not who is ultimately responsible. Look up session provenance separately via the [Sessions API](/docs/en/api/sessions-retrieve). - `type BetaManagedAgentsSessionActor struct{…}` Attribution for a write made by an agent during a session, through the mounted filesystem at `/mnt/memory/`. - `SessionID string` ID of the session that performed the write (a `sesn_...` value). Look up the session via [Retrieve a session](/docs/en/api/sessions-retrieve) for further provenance. - `Type BetaManagedAgentsSessionActorType` - `const BetaManagedAgentsSessionActorTypeSessionActor BetaManagedAgentsSessionActorType = "session_actor"` - `type BetaManagedAgentsAPIActor struct{…}` Attribution for a write made directly via the public API (outside of any session). - `APIKeyID string` ID of the API key that performed the write. This identifies the key, not the secret. - `Type BetaManagedAgentsAPIActorType` - `const BetaManagedAgentsAPIActorTypeAPIActor BetaManagedAgentsAPIActorType = "api_actor"` - `type BetaManagedAgentsUserActor struct{…}` Attribution for a write made by a human user through the Anthropic Console. - `Type BetaManagedAgentsUserActorType` - `const BetaManagedAgentsUserActorTypeUserActor BetaManagedAgentsUserActorType = "user_actor"` - `UserID string` ID of the user who performed the write (a `user_...` value). - `Path string` The memory's path at the time of this write. `null` if and only if `redacted_at` is set. - `RedactedAt Time` A timestamp in RFC 3339 format - `RedactedBy BetaManagedAgentsActorUnion` Identifies who performed a write or redact operation. Captured at write time on the `memory_version` row. The API key that created a session is not recorded on agent writes; attribution answers who made the write, not who is ultimately responsible. Look up session provenance separately via the [Sessions API](/docs/en/api/sessions-retrieve). ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsMemoryVersion, err := client.Beta.MemoryStores.MemoryVersions.Get( context.TODO(), "memory_version_id", anthropic.BetaMemoryStoreMemoryVersionGetParams{ MemoryStoreID: "memory_store_id", }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsMemoryVersion.ID) } ``` #### Response ```json { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "memory_id": "memory_id", "memory_store_id": "memory_store_id", "operation": "created", "type": "memory_version", "content": "content", "content_sha256": "content_sha256", "content_size_bytes": 0, "created_by": { "session_id": "x", "type": "session_actor" }, "path": "path", "redacted_at": "2019-12-27T18:11:19.117Z", "redacted_by": { "session_id": "x", "type": "session_actor" } } ``` ## Redact a memory version `client.Beta.MemoryStores.MemoryVersions.Redact(ctx, memoryVersionID, params) (*BetaManagedAgentsMemoryVersion, error)` **post** `/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact` Redact a memory version ### Parameters - `memoryVersionID string` - `params BetaMemoryStoreMemoryVersionRedactParams` - `MemoryStoreID param.Field[string]` Path param: Path parameter memory_store_id - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaManagedAgentsMemoryVersion struct{…}` A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `ID string` Unique identifier for this version (a `memver_...` value). - `CreatedAt Time` A timestamp in RFC 3339 format - `MemoryID string` ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. - `MemoryStoreID string` ID of the memory store this version belongs to (a `memstore_...` value). - `Operation BetaManagedAgentsMemoryVersionOperation` The kind of mutation a `memory_version` records. Every non-no-op mutation to a memory appends exactly one version row with one of these values. - `const BetaManagedAgentsMemoryVersionOperationCreated BetaManagedAgentsMemoryVersionOperation = "created"` - `const BetaManagedAgentsMemoryVersionOperationModified BetaManagedAgentsMemoryVersionOperation = "modified"` - `const BetaManagedAgentsMemoryVersionOperationDeleted BetaManagedAgentsMemoryVersionOperation = "deleted"` - `Type BetaManagedAgentsMemoryVersionType` - `const BetaManagedAgentsMemoryVersionTypeMemoryVersion BetaManagedAgentsMemoryVersionType = "memory_version"` - `Content string` The memory's UTF-8 text content as of this version. `null` when `view=basic`, when `operation` is `deleted`, or when `redacted_at` is set. - `ContentSha256 string` Lowercase hex SHA-256 digest of `content` as of this version (64 characters). `null` when `redacted_at` is set or `operation` is `deleted`. Populated regardless of `view` otherwise. - `ContentSizeBytes int64` Size of `content` in bytes as of this version. `null` when `redacted_at` is set or `operation` is `deleted`. Populated regardless of `view` otherwise. - `CreatedBy BetaManagedAgentsActorUnion` Identifies who performed a write or redact operation. Captured at write time on the `memory_version` row. The API key that created a session is not recorded on agent writes; attribution answers who made the write, not who is ultimately responsible. Look up session provenance separately via the [Sessions API](/docs/en/api/sessions-retrieve). - `type BetaManagedAgentsSessionActor struct{…}` Attribution for a write made by an agent during a session, through the mounted filesystem at `/mnt/memory/`. - `SessionID string` ID of the session that performed the write (a `sesn_...` value). Look up the session via [Retrieve a session](/docs/en/api/sessions-retrieve) for further provenance. - `Type BetaManagedAgentsSessionActorType` - `const BetaManagedAgentsSessionActorTypeSessionActor BetaManagedAgentsSessionActorType = "session_actor"` - `type BetaManagedAgentsAPIActor struct{…}` Attribution for a write made directly via the public API (outside of any session). - `APIKeyID string` ID of the API key that performed the write. This identifies the key, not the secret. - `Type BetaManagedAgentsAPIActorType` - `const BetaManagedAgentsAPIActorTypeAPIActor BetaManagedAgentsAPIActorType = "api_actor"` - `type BetaManagedAgentsUserActor struct{…}` Attribution for a write made by a human user through the Anthropic Console. - `Type BetaManagedAgentsUserActorType` - `const BetaManagedAgentsUserActorTypeUserActor BetaManagedAgentsUserActorType = "user_actor"` - `UserID string` ID of the user who performed the write (a `user_...` value). - `Path string` The memory's path at the time of this write. `null` if and only if `redacted_at` is set. - `RedactedAt Time` A timestamp in RFC 3339 format - `RedactedBy BetaManagedAgentsActorUnion` Identifies who performed a write or redact operation. Captured at write time on the `memory_version` row. The API key that created a session is not recorded on agent writes; attribution answers who made the write, not who is ultimately responsible. Look up session provenance separately via the [Sessions API](/docs/en/api/sessions-retrieve). ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaManagedAgentsMemoryVersion, err := client.Beta.MemoryStores.MemoryVersions.Redact( context.TODO(), "memory_version_id", anthropic.BetaMemoryStoreMemoryVersionRedactParams{ MemoryStoreID: "memory_store_id", }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaManagedAgentsMemoryVersion.ID) } ``` #### Response ```json { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "memory_id": "memory_id", "memory_store_id": "memory_store_id", "operation": "created", "type": "memory_version", "content": "content", "content_sha256": "content_sha256", "content_size_bytes": 0, "created_by": { "session_id": "x", "type": "session_actor" }, "path": "path", "redacted_at": "2019-12-27T18:11:19.117Z", "redacted_by": { "session_id": "x", "type": "session_actor" } } ``` ## Domain Types ### Beta Managed Agents Actor - `type BetaManagedAgentsActorUnion interface{…}` Identifies who performed a write or redact operation. Captured at write time on the `memory_version` row. The API key that created a session is not recorded on agent writes; attribution answers who made the write, not who is ultimately responsible. Look up session provenance separately via the [Sessions API](/docs/en/api/sessions-retrieve). - `type BetaManagedAgentsSessionActor struct{…}` Attribution for a write made by an agent during a session, through the mounted filesystem at `/mnt/memory/`. - `SessionID string` ID of the session that performed the write (a `sesn_...` value). Look up the session via [Retrieve a session](/docs/en/api/sessions-retrieve) for further provenance. - `Type BetaManagedAgentsSessionActorType` - `const BetaManagedAgentsSessionActorTypeSessionActor BetaManagedAgentsSessionActorType = "session_actor"` - `type BetaManagedAgentsAPIActor struct{…}` Attribution for a write made directly via the public API (outside of any session). - `APIKeyID string` ID of the API key that performed the write. This identifies the key, not the secret. - `Type BetaManagedAgentsAPIActorType` - `const BetaManagedAgentsAPIActorTypeAPIActor BetaManagedAgentsAPIActorType = "api_actor"` - `type BetaManagedAgentsUserActor struct{…}` Attribution for a write made by a human user through the Anthropic Console. - `Type BetaManagedAgentsUserActorType` - `const BetaManagedAgentsUserActorTypeUserActor BetaManagedAgentsUserActorType = "user_actor"` - `UserID string` ID of the user who performed the write (a `user_...` value). ### Beta Managed Agents API Actor - `type BetaManagedAgentsAPIActor struct{…}` Attribution for a write made directly via the public API (outside of any session). - `APIKeyID string` ID of the API key that performed the write. This identifies the key, not the secret. - `Type BetaManagedAgentsAPIActorType` - `const BetaManagedAgentsAPIActorTypeAPIActor BetaManagedAgentsAPIActorType = "api_actor"` ### Beta Managed Agents Memory Version - `type BetaManagedAgentsMemoryVersion struct{…}` A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `ID string` Unique identifier for this version (a `memver_...` value). - `CreatedAt Time` A timestamp in RFC 3339 format - `MemoryID string` ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. - `MemoryStoreID string` ID of the memory store this version belongs to (a `memstore_...` value). - `Operation BetaManagedAgentsMemoryVersionOperation` The kind of mutation a `memory_version` records. Every non-no-op mutation to a memory appends exactly one version row with one of these values. - `const BetaManagedAgentsMemoryVersionOperationCreated BetaManagedAgentsMemoryVersionOperation = "created"` - `const BetaManagedAgentsMemoryVersionOperationModified BetaManagedAgentsMemoryVersionOperation = "modified"` - `const BetaManagedAgentsMemoryVersionOperationDeleted BetaManagedAgentsMemoryVersionOperation = "deleted"` - `Type BetaManagedAgentsMemoryVersionType` - `const BetaManagedAgentsMemoryVersionTypeMemoryVersion BetaManagedAgentsMemoryVersionType = "memory_version"` - `Content string` The memory's UTF-8 text content as of this version. `null` when `view=basic`, when `operation` is `deleted`, or when `redacted_at` is set. - `ContentSha256 string` Lowercase hex SHA-256 digest of `content` as of this version (64 characters). `null` when `redacted_at` is set or `operation` is `deleted`. Populated regardless of `view` otherwise. - `ContentSizeBytes int64` Size of `content` in bytes as of this version. `null` when `redacted_at` is set or `operation` is `deleted`. Populated regardless of `view` otherwise. - `CreatedBy BetaManagedAgentsActorUnion` Identifies who performed a write or redact operation. Captured at write time on the `memory_version` row. The API key that created a session is not recorded on agent writes; attribution answers who made the write, not who is ultimately responsible. Look up session provenance separately via the [Sessions API](/docs/en/api/sessions-retrieve). - `type BetaManagedAgentsSessionActor struct{…}` Attribution for a write made by an agent during a session, through the mounted filesystem at `/mnt/memory/`. - `SessionID string` ID of the session that performed the write (a `sesn_...` value). Look up the session via [Retrieve a session](/docs/en/api/sessions-retrieve) for further provenance. - `Type BetaManagedAgentsSessionActorType` - `const BetaManagedAgentsSessionActorTypeSessionActor BetaManagedAgentsSessionActorType = "session_actor"` - `type BetaManagedAgentsAPIActor struct{…}` Attribution for a write made directly via the public API (outside of any session). - `APIKeyID string` ID of the API key that performed the write. This identifies the key, not the secret. - `Type BetaManagedAgentsAPIActorType` - `const BetaManagedAgentsAPIActorTypeAPIActor BetaManagedAgentsAPIActorType = "api_actor"` - `type BetaManagedAgentsUserActor struct{…}` Attribution for a write made by a human user through the Anthropic Console. - `Type BetaManagedAgentsUserActorType` - `const BetaManagedAgentsUserActorTypeUserActor BetaManagedAgentsUserActorType = "user_actor"` - `UserID string` ID of the user who performed the write (a `user_...` value). - `Path string` The memory's path at the time of this write. `null` if and only if `redacted_at` is set. - `RedactedAt Time` A timestamp in RFC 3339 format - `RedactedBy BetaManagedAgentsActorUnion` Identifies who performed a write or redact operation. Captured at write time on the `memory_version` row. The API key that created a session is not recorded on agent writes; attribution answers who made the write, not who is ultimately responsible. Look up session provenance separately via the [Sessions API](/docs/en/api/sessions-retrieve). ### Beta Managed Agents Memory Version Operation - `type BetaManagedAgentsMemoryVersionOperation string` The kind of mutation a `memory_version` records. Every non-no-op mutation to a memory appends exactly one version row with one of these values. - `const BetaManagedAgentsMemoryVersionOperationCreated BetaManagedAgentsMemoryVersionOperation = "created"` - `const BetaManagedAgentsMemoryVersionOperationModified BetaManagedAgentsMemoryVersionOperation = "modified"` - `const BetaManagedAgentsMemoryVersionOperationDeleted BetaManagedAgentsMemoryVersionOperation = "deleted"` ### Beta Managed Agents Session Actor - `type BetaManagedAgentsSessionActor struct{…}` Attribution for a write made by an agent during a session, through the mounted filesystem at `/mnt/memory/`. - `SessionID string` ID of the session that performed the write (a `sesn_...` value). Look up the session via [Retrieve a session](/docs/en/api/sessions-retrieve) for further provenance. - `Type BetaManagedAgentsSessionActorType` - `const BetaManagedAgentsSessionActorTypeSessionActor BetaManagedAgentsSessionActorType = "session_actor"` ### Beta Managed Agents User Actor - `type BetaManagedAgentsUserActor struct{…}` Attribution for a write made by a human user through the Anthropic Console. - `Type BetaManagedAgentsUserActorType` - `const BetaManagedAgentsUserActorTypeUserActor BetaManagedAgentsUserActorType = "user_actor"` - `UserID string` ID of the user who performed the write (a `user_...` value). # Files ## Upload File `client.Beta.Files.Upload(ctx, params) (*FileMetadata, error)` **post** `/v1/files` Upload File ### Parameters - `params BetaFileUploadParams` - `File param.Field[Reader]` Body param: The file to upload - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type FileMetadata struct{…}` - `ID string` Unique object identifier. The format and length of IDs may change over time. - `CreatedAt Time` RFC 3339 datetime string representing when the file was created. - `Filename string` Original filename of the uploaded file. - `MimeType string` MIME type of the file. - `SizeBytes int64` Size of the file in bytes. - `Type File` Object type. For files, this is always `"file"`. - `const FileFile File = "file"` - `Downloadable bool` Whether the file can be downloaded. - `Scope BetaFileScope` The scope of this file, indicating the context in which it was created (e.g., a session). - `ID string` The ID of the scoping resource (e.g., the session ID). - `Type Session` The type of scope (e.g., `"session"`). - `const SessionSession Session = "session"` ### Example ```go package main import ( "bytes" "context" "fmt" "io" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) fileMetadata, err := client.Beta.Files.Upload(context.TODO(), anthropic.BetaFileUploadParams{ File: io.Reader(bytes.NewBuffer([]byte("Example data"))), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", fileMetadata.ID) } ``` #### Response ```json { "id": "file_011CNha8iCJcU1wXNR6q4V8w", "created_at": "2025-04-15T18:37:24.100435Z", "filename": "document.pdf", "mime_type": "application/pdf", "size_bytes": 102400, "type": "file", "downloadable": false, "scope": { "id": "id", "type": "session" } } ``` ## List Files `client.Beta.Files.List(ctx, params) (*Page[FileMetadata], error)` **get** `/v1/files` List Files ### Parameters - `params BetaFileListParams` - `AfterID param.Field[string]` Query param: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. - `BeforeID param.Field[string]` Query param: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. - `Limit param.Field[int64]` Query param: Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. - `ScopeID param.Field[string]` Query param: Filter by scope ID. Only returns files associated with the specified scope (e.g., a session ID). - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type FileMetadata struct{…}` - `ID string` Unique object identifier. The format and length of IDs may change over time. - `CreatedAt Time` RFC 3339 datetime string representing when the file was created. - `Filename string` Original filename of the uploaded file. - `MimeType string` MIME type of the file. - `SizeBytes int64` Size of the file in bytes. - `Type File` Object type. For files, this is always `"file"`. - `const FileFile File = "file"` - `Downloadable bool` Whether the file can be downloaded. - `Scope BetaFileScope` The scope of this file, indicating the context in which it was created (e.g., a session). - `ID string` The ID of the scoping resource (e.g., the session ID). - `Type Session` The type of scope (e.g., `"session"`). - `const SessionSession Session = "session"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) page, err := client.Beta.Files.List(context.TODO(), anthropic.BetaFileListParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "data": [ { "id": "file_011CNha8iCJcU1wXNR6q4V8w", "created_at": "2025-04-15T18:37:24.100435Z", "filename": "document.pdf", "mime_type": "application/pdf", "size_bytes": 102400, "type": "file", "downloadable": false, "scope": { "id": "id", "type": "session" } } ], "first_id": "file_011CNha8iCJcU1wXNR6q4V8w", "has_more": true, "last_id": "file_013Zva2CMHLNnXjNJJKqJ2EF" } ``` ## Download File `client.Beta.Files.Download(ctx, fileID, query) (*Response, error)` **get** `/v1/files/{file_id}/content` Download File ### Parameters - `fileID string` ID of the File. - `query BetaFileDownloadParams` - `Betas param.Field[[]AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaFileDownloadResponse interface{…}` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) response, err := client.Beta.Files.Download( context.TODO(), "file_id", anthropic.BetaFileDownloadParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response) } ``` ## Get File Metadata `client.Beta.Files.GetMetadata(ctx, fileID, query) (*FileMetadata, error)` **get** `/v1/files/{file_id}` Get File Metadata ### Parameters - `fileID string` ID of the File. - `query BetaFileGetMetadataParams` - `Betas param.Field[[]AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type FileMetadata struct{…}` - `ID string` Unique object identifier. The format and length of IDs may change over time. - `CreatedAt Time` RFC 3339 datetime string representing when the file was created. - `Filename string` Original filename of the uploaded file. - `MimeType string` MIME type of the file. - `SizeBytes int64` Size of the file in bytes. - `Type File` Object type. For files, this is always `"file"`. - `const FileFile File = "file"` - `Downloadable bool` Whether the file can be downloaded. - `Scope BetaFileScope` The scope of this file, indicating the context in which it was created (e.g., a session). - `ID string` The ID of the scoping resource (e.g., the session ID). - `Type Session` The type of scope (e.g., `"session"`). - `const SessionSession Session = "session"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) fileMetadata, err := client.Beta.Files.GetMetadata( context.TODO(), "file_id", anthropic.BetaFileGetMetadataParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", fileMetadata.ID) } ``` #### Response ```json { "id": "file_011CNha8iCJcU1wXNR6q4V8w", "created_at": "2025-04-15T18:37:24.100435Z", "filename": "document.pdf", "mime_type": "application/pdf", "size_bytes": 102400, "type": "file", "downloadable": false, "scope": { "id": "id", "type": "session" } } ``` ## Delete File `client.Beta.Files.Delete(ctx, fileID, body) (*DeletedFile, error)` **delete** `/v1/files/{file_id}` Delete File ### Parameters - `fileID string` ID of the File. - `body BetaFileDeleteParams` - `Betas param.Field[[]AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type DeletedFile struct{…}` - `ID string` ID of the deleted file. - `Type DeletedFileType` Deleted object type. For file deletion, this is always `"file_deleted"`. - `const DeletedFileTypeFileDeleted DeletedFileType = "file_deleted"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) deletedFile, err := client.Beta.Files.Delete( context.TODO(), "file_id", anthropic.BetaFileDeleteParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", deletedFile.ID) } ``` #### Response ```json { "id": "file_011CNha8iCJcU1wXNR6q4V8w", "type": "file_deleted" } ``` ## Domain Types ### Beta File Scope - `type BetaFileScope struct{…}` - `ID string` The ID of the scoping resource (e.g., the session ID). - `Type Session` The type of scope (e.g., `"session"`). - `const SessionSession Session = "session"` ### Deleted File - `type DeletedFile struct{…}` - `ID string` ID of the deleted file. - `Type DeletedFileType` Deleted object type. For file deletion, this is always `"file_deleted"`. - `const DeletedFileTypeFileDeleted DeletedFileType = "file_deleted"` ### File Metadata - `type FileMetadata struct{…}` - `ID string` Unique object identifier. The format and length of IDs may change over time. - `CreatedAt Time` RFC 3339 datetime string representing when the file was created. - `Filename string` Original filename of the uploaded file. - `MimeType string` MIME type of the file. - `SizeBytes int64` Size of the file in bytes. - `Type File` Object type. For files, this is always `"file"`. - `const FileFile File = "file"` - `Downloadable bool` Whether the file can be downloaded. - `Scope BetaFileScope` The scope of this file, indicating the context in which it was created (e.g., a session). - `ID string` The ID of the scoping resource (e.g., the session ID). - `Type Session` The type of scope (e.g., `"session"`). - `const SessionSession Session = "session"` # Skills ## Create Skill `client.Beta.Skills.New(ctx, params) (*BetaSkillNewResponse, error)` **post** `/v1/skills` Create Skill ### Parameters - `params BetaSkillNewParams` - `DisplayTitle param.Field[string]` Body param: Display title for the skill. This is a human-readable label that is not included in the prompt sent to the model. - `Files param.Field[[]Reader]` Body param: Files to upload for the skill. All files must be in the same top-level directory and must include a SKILL.md file at the root of that directory. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaSkillNewResponse struct{…}` - `ID string` Unique identifier for the skill. The format and length of IDs may change over time. - `CreatedAt string` ISO 8601 timestamp of when the skill was created. - `DisplayTitle string` Display title for the skill. This is a human-readable label that is not included in the prompt sent to the model. - `LatestVersion string` The latest version identifier for the skill. This represents the most recent version of the skill that has been created. - `Source string` Source of the skill. This may be one of the following values: * `"custom"`: the skill was created by a user * `"anthropic"`: the skill was created by Anthropic - `Type string` Object type. For Skills, this is always `"skill"`. - `UpdatedAt string` ISO 8601 timestamp of when the skill was last updated. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) skill, err := client.Beta.Skills.New(context.TODO(), anthropic.BetaSkillNewParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", skill.ID) } ``` #### Response ```json { "id": "skill_01JAbcdefghijklmnopqrstuvw", "created_at": "2024-10-30T23:58:27.427722Z", "display_title": "My Custom Skill", "latest_version": "1759178010641129", "source": "custom", "type": "type", "updated_at": "2024-10-30T23:58:27.427722Z" } ``` ## List Skills `client.Beta.Skills.List(ctx, params) (*PageCursor[BetaSkillListResponse], error)` **get** `/v1/skills` List Skills ### Parameters - `params BetaSkillListParams` - `Limit param.Field[int64]` Query param: Number of results to return per page. Maximum value is 100. Defaults to 20. - `Page param.Field[string]` Query param: Pagination token for fetching a specific page of results. Pass the value from a previous response's `next_page` field to get the next page of results. - `Source param.Field[string]` Query param: Filter skills by source. If provided, only skills from the specified source will be returned: * `"custom"`: only return user-created skills * `"anthropic"`: only return Anthropic-created skills - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaSkillListResponse struct{…}` - `ID string` Unique identifier for the skill. The format and length of IDs may change over time. - `CreatedAt string` ISO 8601 timestamp of when the skill was created. - `DisplayTitle string` Display title for the skill. This is a human-readable label that is not included in the prompt sent to the model. - `LatestVersion string` The latest version identifier for the skill. This represents the most recent version of the skill that has been created. - `Source string` Source of the skill. This may be one of the following values: * `"custom"`: the skill was created by a user * `"anthropic"`: the skill was created by Anthropic - `Type string` Object type. For Skills, this is always `"skill"`. - `UpdatedAt string` ISO 8601 timestamp of when the skill was last updated. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) page, err := client.Beta.Skills.List(context.TODO(), anthropic.BetaSkillListParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "data": [ { "id": "skill_01JAbcdefghijklmnopqrstuvw", "created_at": "2024-10-30T23:58:27.427722Z", "display_title": "My Custom Skill", "latest_version": "1759178010641129", "source": "custom", "type": "type", "updated_at": "2024-10-30T23:58:27.427722Z" } ], "has_more": true, "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ## Get Skill `client.Beta.Skills.Get(ctx, skillID, query) (*BetaSkillGetResponse, error)` **get** `/v1/skills/{skill_id}` Get Skill ### Parameters - `skillID string` Unique identifier for the skill. The format and length of IDs may change over time. - `query BetaSkillGetParams` - `Betas param.Field[[]AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaSkillGetResponse struct{…}` - `ID string` Unique identifier for the skill. The format and length of IDs may change over time. - `CreatedAt string` ISO 8601 timestamp of when the skill was created. - `DisplayTitle string` Display title for the skill. This is a human-readable label that is not included in the prompt sent to the model. - `LatestVersion string` The latest version identifier for the skill. This represents the most recent version of the skill that has been created. - `Source string` Source of the skill. This may be one of the following values: * `"custom"`: the skill was created by a user * `"anthropic"`: the skill was created by Anthropic - `Type string` Object type. For Skills, this is always `"skill"`. - `UpdatedAt string` ISO 8601 timestamp of when the skill was last updated. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) skill, err := client.Beta.Skills.Get( context.TODO(), "skill_id", anthropic.BetaSkillGetParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", skill.ID) } ``` #### Response ```json { "id": "skill_01JAbcdefghijklmnopqrstuvw", "created_at": "2024-10-30T23:58:27.427722Z", "display_title": "My Custom Skill", "latest_version": "1759178010641129", "source": "custom", "type": "type", "updated_at": "2024-10-30T23:58:27.427722Z" } ``` ## Delete Skill `client.Beta.Skills.Delete(ctx, skillID, body) (*BetaSkillDeleteResponse, error)` **delete** `/v1/skills/{skill_id}` Delete Skill ### Parameters - `skillID string` Unique identifier for the skill. The format and length of IDs may change over time. - `body BetaSkillDeleteParams` - `Betas param.Field[[]AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaSkillDeleteResponse struct{…}` - `ID string` Unique identifier for the skill. The format and length of IDs may change over time. - `Type string` Deleted object type. For Skills, this is always `"skill_deleted"`. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) skill, err := client.Beta.Skills.Delete( context.TODO(), "skill_id", anthropic.BetaSkillDeleteParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", skill.ID) } ``` #### Response ```json { "id": "skill_01JAbcdefghijklmnopqrstuvw", "type": "type" } ``` # Versions ## Create Skill Version `client.Beta.Skills.Versions.New(ctx, skillID, params) (*BetaSkillVersionNewResponse, error)` **post** `/v1/skills/{skill_id}/versions` Create Skill Version ### Parameters - `skillID string` Unique identifier for the skill. The format and length of IDs may change over time. - `params BetaSkillVersionNewParams` - `Files param.Field[[]Reader]` Body param: Files to upload for the skill. All files must be in the same top-level directory and must include a SKILL.md file at the root of that directory. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaSkillVersionNewResponse struct{…}` - `ID string` Unique identifier for the skill version. The format and length of IDs may change over time. - `CreatedAt string` ISO 8601 timestamp of when the skill version was created. - `Description string` Description of the skill version. This is extracted from the SKILL.md file in the skill upload. - `Directory string` Directory name of the skill version. This is the top-level directory name that was extracted from the uploaded files. - `Name string` Human-readable name of the skill version. This is extracted from the SKILL.md file in the skill upload. - `SkillID string` Identifier for the skill that this version belongs to. - `Type string` Object type. For Skill Versions, this is always `"skill_version"`. - `Version string` Version identifier for the skill. Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129"). ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) version, err := client.Beta.Skills.Versions.New( context.TODO(), "skill_id", anthropic.BetaSkillVersionNewParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", version.ID) } ``` #### Response ```json { "id": "skillver_01JAbcdefghijklmnopqrstuvw", "created_at": "2024-10-30T23:58:27.427722Z", "description": "A custom skill for doing something useful", "directory": "my-skill", "name": "my-skill", "skill_id": "skill_01JAbcdefghijklmnopqrstuvw", "type": "type", "version": "1759178010641129" } ``` ## List Skill Versions `client.Beta.Skills.Versions.List(ctx, skillID, params) (*PageCursor[BetaSkillVersionListResponse], error)` **get** `/v1/skills/{skill_id}/versions` List Skill Versions ### Parameters - `skillID string` Unique identifier for the skill. The format and length of IDs may change over time. - `params BetaSkillVersionListParams` - `Limit param.Field[int64]` Query param: Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. - `Page param.Field[string]` Query param: Optionally set to the `next_page` token from the previous response. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaSkillVersionListResponse struct{…}` - `ID string` Unique identifier for the skill version. The format and length of IDs may change over time. - `CreatedAt string` ISO 8601 timestamp of when the skill version was created. - `Description string` Description of the skill version. This is extracted from the SKILL.md file in the skill upload. - `Directory string` Directory name of the skill version. This is the top-level directory name that was extracted from the uploaded files. - `Name string` Human-readable name of the skill version. This is extracted from the SKILL.md file in the skill upload. - `SkillID string` Identifier for the skill that this version belongs to. - `Type string` Object type. For Skill Versions, this is always `"skill_version"`. - `Version string` Version identifier for the skill. Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129"). ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) page, err := client.Beta.Skills.Versions.List( context.TODO(), "skill_id", anthropic.BetaSkillVersionListParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "data": [ { "id": "skillver_01JAbcdefghijklmnopqrstuvw", "created_at": "2024-10-30T23:58:27.427722Z", "description": "A custom skill for doing something useful", "directory": "my-skill", "name": "my-skill", "skill_id": "skill_01JAbcdefghijklmnopqrstuvw", "type": "type", "version": "1759178010641129" } ], "has_more": true, "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ## Download Skill Version Content `client.Beta.Skills.Versions.Download(ctx, version, params) (*Response, error)` **get** `/v1/skills/{skill_id}/versions/{version}/content` Download a skill version's content as a zip archive. ### Parameters - `version string` Version identifier for the skill. Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129"). - `params BetaSkillVersionDownloadParams` - `SkillID param.Field[string]` Path param: Unique identifier for the skill. The format and length of IDs may change over time. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaSkillVersionDownloadResponse interface{…}` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) response, err := client.Beta.Skills.Versions.Download( context.TODO(), "version", anthropic.BetaSkillVersionDownloadParams{ SkillID: "skill_id", }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response) } ``` ## Get Skill Version `client.Beta.Skills.Versions.Get(ctx, version, params) (*BetaSkillVersionGetResponse, error)` **get** `/v1/skills/{skill_id}/versions/{version}` Get Skill Version ### Parameters - `version string` Version identifier for the skill. Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129"). - `params BetaSkillVersionGetParams` - `SkillID param.Field[string]` Path param: Unique identifier for the skill. The format and length of IDs may change over time. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaSkillVersionGetResponse struct{…}` - `ID string` Unique identifier for the skill version. The format and length of IDs may change over time. - `CreatedAt string` ISO 8601 timestamp of when the skill version was created. - `Description string` Description of the skill version. This is extracted from the SKILL.md file in the skill upload. - `Directory string` Directory name of the skill version. This is the top-level directory name that was extracted from the uploaded files. - `Name string` Human-readable name of the skill version. This is extracted from the SKILL.md file in the skill upload. - `SkillID string` Identifier for the skill that this version belongs to. - `Type string` Object type. For Skill Versions, this is always `"skill_version"`. - `Version string` Version identifier for the skill. Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129"). ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) version, err := client.Beta.Skills.Versions.Get( context.TODO(), "version", anthropic.BetaSkillVersionGetParams{ SkillID: "skill_id", }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", version.ID) } ``` #### Response ```json { "id": "skillver_01JAbcdefghijklmnopqrstuvw", "created_at": "2024-10-30T23:58:27.427722Z", "description": "A custom skill for doing something useful", "directory": "my-skill", "name": "my-skill", "skill_id": "skill_01JAbcdefghijklmnopqrstuvw", "type": "type", "version": "1759178010641129" } ``` ## Delete Skill Version `client.Beta.Skills.Versions.Delete(ctx, version, params) (*BetaSkillVersionDeleteResponse, error)` **delete** `/v1/skills/{skill_id}/versions/{version}` Delete Skill Version ### Parameters - `version string` Version identifier for the skill. Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129"). - `params BetaSkillVersionDeleteParams` - `SkillID param.Field[string]` Path param: Unique identifier for the skill. The format and length of IDs may change over time. - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaSkillVersionDeleteResponse struct{…}` - `ID string` Version identifier for the skill. Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129"). - `Type string` Deleted object type. For Skill Versions, this is always `"skill_version_deleted"`. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) version, err := client.Beta.Skills.Versions.Delete( context.TODO(), "version", anthropic.BetaSkillVersionDeleteParams{ SkillID: "skill_id", }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", version.ID) } ``` #### Response ```json { "id": "1759178010641129", "type": "type" } ``` # User Profiles ## Create User Profile `client.Beta.UserProfiles.New(ctx, params) (*BetaUserProfile, error)` **post** `/v1/user_profiles` Create User Profile ### Parameters - `params BetaUserProfileNewParams` - `ExternalID param.Field[string]` Body param: Platform's own identifier for this user. Not enforced unique. Maximum 255 characters. - `Metadata param.Field[map[string, string]]` Body param: Free-form key-value data to attach to this user profile. Maximum 16 keys, with keys up to 64 characters and values up to 512 characters. Values must be non-empty strings. - `Name param.Field[string]` Body param: Display name of the entity this profile represents. Required when relationship is `resold` (the resold-to company's name); optional otherwise. Maximum 255 characters. - `Relationship param.Field[BetaUserProfileNewParamsRelationship]` Body param: How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage. - `const BetaUserProfileNewParamsRelationshipExternal BetaUserProfileNewParamsRelationship = "external"` - `const BetaUserProfileNewParamsRelationshipResold BetaUserProfileNewParamsRelationship = "resold"` - `const BetaUserProfileNewParamsRelationshipInternal BetaUserProfileNewParamsRelationship = "internal"` - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaUserProfile struct{…}` - `ID string` Unique identifier for this user profile, prefixed `uprof_`. - `CreatedAt Time` A timestamp in RFC 3339 format - `Metadata map[string, string]` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `Relationship BetaUserProfileRelationship` How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage. - `const BetaUserProfileRelationshipExternal BetaUserProfileRelationship = "external"` - `const BetaUserProfileRelationshipResold BetaUserProfileRelationship = "resold"` - `const BetaUserProfileRelationshipInternal BetaUserProfileRelationship = "internal"` - `TrustGrants map[string, BetaUserProfileTrustGrant]` Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight. - `Status BetaUserProfileTrustGrantStatus` Status of the trust grant. - `const BetaUserProfileTrustGrantStatusActive BetaUserProfileTrustGrantStatus = "active"` - `const BetaUserProfileTrustGrantStatusPending BetaUserProfileTrustGrantStatus = "pending"` - `const BetaUserProfileTrustGrantStatusRejected BetaUserProfileTrustGrantStatus = "rejected"` - `Type BetaUserProfileType` Object type. Always `user_profile`. - `const BetaUserProfileTypeUserProfile BetaUserProfileType = "user_profile"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `ExternalID string` Platform's own identifier for this user. Not enforced unique. - `Name string` Display name of the entity this profile represents. For `resold` this is the resold-to company's name. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaUserProfile, err := client.Beta.UserProfiles.New(context.TODO(), anthropic.BetaUserProfileNewParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaUserProfile.ID) } ``` #### Response ```json { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, "relationship": "external", "trust_grants": { "cyber": { "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", "external_id": "user_12345", "name": "Example User" } ``` ## List User Profiles `client.Beta.UserProfiles.List(ctx, params) (*PageCursor[BetaUserProfile], error)` **get** `/v1/user_profiles` List User Profiles ### Parameters - `params BetaUserProfileListParams` - `Limit param.Field[int64]` Query param: Query parameter for limit - `Order param.Field[BetaUserProfileListParamsOrder]` Query param: Query parameter for order - `const BetaUserProfileListParamsOrderAsc BetaUserProfileListParamsOrder = "asc"` - `const BetaUserProfileListParamsOrderDesc BetaUserProfileListParamsOrder = "desc"` - `Page param.Field[string]` Query param: Query parameter for page - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaUserProfile struct{…}` - `ID string` Unique identifier for this user profile, prefixed `uprof_`. - `CreatedAt Time` A timestamp in RFC 3339 format - `Metadata map[string, string]` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `Relationship BetaUserProfileRelationship` How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage. - `const BetaUserProfileRelationshipExternal BetaUserProfileRelationship = "external"` - `const BetaUserProfileRelationshipResold BetaUserProfileRelationship = "resold"` - `const BetaUserProfileRelationshipInternal BetaUserProfileRelationship = "internal"` - `TrustGrants map[string, BetaUserProfileTrustGrant]` Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight. - `Status BetaUserProfileTrustGrantStatus` Status of the trust grant. - `const BetaUserProfileTrustGrantStatusActive BetaUserProfileTrustGrantStatus = "active"` - `const BetaUserProfileTrustGrantStatusPending BetaUserProfileTrustGrantStatus = "pending"` - `const BetaUserProfileTrustGrantStatusRejected BetaUserProfileTrustGrantStatus = "rejected"` - `Type BetaUserProfileType` Object type. Always `user_profile`. - `const BetaUserProfileTypeUserProfile BetaUserProfileType = "user_profile"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `ExternalID string` Platform's own identifier for this user. Not enforced unique. - `Name string` Display name of the entity this profile represents. For `resold` this is the resold-to company's name. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) page, err := client.Beta.UserProfiles.List(context.TODO(), anthropic.BetaUserProfileListParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "data": [ { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, "relationship": "external", "trust_grants": { "cyber": { "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", "external_id": "user_12345", "name": "Example User" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ## Get User Profile `client.Beta.UserProfiles.Get(ctx, userProfileID, query) (*BetaUserProfile, error)` **get** `/v1/user_profiles/{user_profile_id}` Get User Profile ### Parameters - `userProfileID string` - `query BetaUserProfileGetParams` - `Betas param.Field[[]AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaUserProfile struct{…}` - `ID string` Unique identifier for this user profile, prefixed `uprof_`. - `CreatedAt Time` A timestamp in RFC 3339 format - `Metadata map[string, string]` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `Relationship BetaUserProfileRelationship` How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage. - `const BetaUserProfileRelationshipExternal BetaUserProfileRelationship = "external"` - `const BetaUserProfileRelationshipResold BetaUserProfileRelationship = "resold"` - `const BetaUserProfileRelationshipInternal BetaUserProfileRelationship = "internal"` - `TrustGrants map[string, BetaUserProfileTrustGrant]` Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight. - `Status BetaUserProfileTrustGrantStatus` Status of the trust grant. - `const BetaUserProfileTrustGrantStatusActive BetaUserProfileTrustGrantStatus = "active"` - `const BetaUserProfileTrustGrantStatusPending BetaUserProfileTrustGrantStatus = "pending"` - `const BetaUserProfileTrustGrantStatusRejected BetaUserProfileTrustGrantStatus = "rejected"` - `Type BetaUserProfileType` Object type. Always `user_profile`. - `const BetaUserProfileTypeUserProfile BetaUserProfileType = "user_profile"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `ExternalID string` Platform's own identifier for this user. Not enforced unique. - `Name string` Display name of the entity this profile represents. For `resold` this is the resold-to company's name. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaUserProfile, err := client.Beta.UserProfiles.Get( context.TODO(), "uprof_011CZkZCu8hGbp5mYRQgUmz9", anthropic.BetaUserProfileGetParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaUserProfile.ID) } ``` #### Response ```json { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, "relationship": "external", "trust_grants": { "cyber": { "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", "external_id": "user_12345", "name": "Example User" } ``` ## Update User Profile `client.Beta.UserProfiles.Update(ctx, userProfileID, params) (*BetaUserProfile, error)` **post** `/v1/user_profiles/{user_profile_id}` Update User Profile ### Parameters - `userProfileID string` - `params BetaUserProfileUpdateParams` - `ExternalID param.Field[string]` Body param: If present, replaces the stored external_id. Omit to leave unchanged. Maximum 255 characters. - `Metadata param.Field[map[string, string]]` Body param: Key-value pairs to merge into the stored metadata. Keys provided overwrite existing values. To remove a key, set its value to an empty string. Keys not provided are left unchanged. Maximum 16 keys, with keys up to 64 characters and values up to 512 characters. - `Name param.Field[string]` Body param: If present, replaces the stored name. Omit to leave unchanged. Maximum 255 characters. - `Relationship param.Field[BetaUserProfileUpdateParamsRelationship]` Body param: How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage. - `const BetaUserProfileUpdateParamsRelationshipExternal BetaUserProfileUpdateParamsRelationship = "external"` - `const BetaUserProfileUpdateParamsRelationshipResold BetaUserProfileUpdateParamsRelationship = "resold"` - `const BetaUserProfileUpdateParamsRelationshipInternal BetaUserProfileUpdateParamsRelationship = "internal"` - `Betas param.Field[[]AnthropicBeta]` Header param: Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaUserProfile struct{…}` - `ID string` Unique identifier for this user profile, prefixed `uprof_`. - `CreatedAt Time` A timestamp in RFC 3339 format - `Metadata map[string, string]` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `Relationship BetaUserProfileRelationship` How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage. - `const BetaUserProfileRelationshipExternal BetaUserProfileRelationship = "external"` - `const BetaUserProfileRelationshipResold BetaUserProfileRelationship = "resold"` - `const BetaUserProfileRelationshipInternal BetaUserProfileRelationship = "internal"` - `TrustGrants map[string, BetaUserProfileTrustGrant]` Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight. - `Status BetaUserProfileTrustGrantStatus` Status of the trust grant. - `const BetaUserProfileTrustGrantStatusActive BetaUserProfileTrustGrantStatus = "active"` - `const BetaUserProfileTrustGrantStatusPending BetaUserProfileTrustGrantStatus = "pending"` - `const BetaUserProfileTrustGrantStatusRejected BetaUserProfileTrustGrantStatus = "rejected"` - `Type BetaUserProfileType` Object type. Always `user_profile`. - `const BetaUserProfileTypeUserProfile BetaUserProfileType = "user_profile"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `ExternalID string` Platform's own identifier for this user. Not enforced unique. - `Name string` Display name of the entity this profile represents. For `resold` this is the resold-to company's name. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaUserProfile, err := client.Beta.UserProfiles.Update( context.TODO(), "uprof_011CZkZCu8hGbp5mYRQgUmz9", anthropic.BetaUserProfileUpdateParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaUserProfile.ID) } ``` #### Response ```json { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, "relationship": "external", "trust_grants": { "cyber": { "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", "external_id": "user_12345", "name": "Example User" } ``` ## Create Enrollment URL `client.Beta.UserProfiles.NewEnrollmentURL(ctx, userProfileID, body) (*BetaUserProfileEnrollmentURL, error)` **post** `/v1/user_profiles/{user_profile_id}/enrollment_url` Create Enrollment URL ### Parameters - `userProfileID string` - `body BetaUserProfileNewEnrollmentURLParams` - `Betas param.Field[[]AnthropicBeta]` Optional header to specify the beta version(s) you want to use. - `string` - `type AnthropicBeta string` - `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"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` ### Returns - `type BetaUserProfileEnrollmentURL struct{…}` - `ExpiresAt Time` A timestamp in RFC 3339 format - `Type BetaUserProfileEnrollmentURLType` Object type. Always `enrollment_url`. - `const BetaUserProfileEnrollmentURLTypeEnrollmentURL BetaUserProfileEnrollmentURLType = "enrollment_url"` - `URL string` Enrollment URL to send to the end user. Valid until `expires_at`. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaUserProfileEnrollmentURL, err := client.Beta.UserProfiles.NewEnrollmentURL( context.TODO(), "uprof_011CZkZCu8hGbp5mYRQgUmz9", anthropic.BetaUserProfileNewEnrollmentURLParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaUserProfileEnrollmentURL.ExpiresAt) } ``` #### Response ```json { "expires_at": "2026-03-15T10:15:00Z", "type": "enrollment_url", "url": "https://platform.claude.com/user-profiles/enrollment/M3J0bGJxZ2ppMnptbnB1" } ``` ## Domain Types ### Beta User Profile - `type BetaUserProfile struct{…}` - `ID string` Unique identifier for this user profile, prefixed `uprof_`. - `CreatedAt Time` A timestamp in RFC 3339 format - `Metadata map[string, string]` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `Relationship BetaUserProfileRelationship` How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage. - `const BetaUserProfileRelationshipExternal BetaUserProfileRelationship = "external"` - `const BetaUserProfileRelationshipResold BetaUserProfileRelationship = "resold"` - `const BetaUserProfileRelationshipInternal BetaUserProfileRelationship = "internal"` - `TrustGrants map[string, BetaUserProfileTrustGrant]` Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight. - `Status BetaUserProfileTrustGrantStatus` Status of the trust grant. - `const BetaUserProfileTrustGrantStatusActive BetaUserProfileTrustGrantStatus = "active"` - `const BetaUserProfileTrustGrantStatusPending BetaUserProfileTrustGrantStatus = "pending"` - `const BetaUserProfileTrustGrantStatusRejected BetaUserProfileTrustGrantStatus = "rejected"` - `Type BetaUserProfileType` Object type. Always `user_profile`. - `const BetaUserProfileTypeUserProfile BetaUserProfileType = "user_profile"` - `UpdatedAt Time` A timestamp in RFC 3339 format - `ExternalID string` Platform's own identifier for this user. Not enforced unique. - `Name string` Display name of the entity this profile represents. For `resold` this is the resold-to company's name. ### Beta User Profile Enrollment URL - `type BetaUserProfileEnrollmentURL struct{…}` - `ExpiresAt Time` A timestamp in RFC 3339 format - `Type BetaUserProfileEnrollmentURLType` Object type. Always `enrollment_url`. - `const BetaUserProfileEnrollmentURLTypeEnrollmentURL BetaUserProfileEnrollmentURLType = "enrollment_url"` - `URL string` Enrollment URL to send to the end user. Valid until `expires_at`. ### Beta User Profile Trust Grant - `type BetaUserProfileTrustGrant struct{…}` - `Status BetaUserProfileTrustGrantStatus` Status of the trust grant. - `const BetaUserProfileTrustGrantStatusActive BetaUserProfileTrustGrantStatus = "active"` - `const BetaUserProfileTrustGrantStatusPending BetaUserProfileTrustGrantStatus = "pending"` - `const BetaUserProfileTrustGrantStatusRejected BetaUserProfileTrustGrantStatus = "rejected"` # Webhooks ## Domain Types ### Beta Webhook Event - `type BetaWebhookEvent struct{…}` - `ID string` Unique event identifier for idempotency. - `CreatedAt Time` RFC 3339 timestamp when the event occurred. - `Data BetaWebhookEventDataUnion` - `type BetaWebhookSessionCreatedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionCreated` - `const SessionCreatedSessionCreated SessionCreated = "session.created"` - `WorkspaceID string` - `type BetaWebhookSessionPendingEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionPending` - `const SessionPendingSessionPending SessionPending = "session.pending"` - `WorkspaceID string` - `type BetaWebhookSessionRunningEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionRunning` - `const SessionRunningSessionRunning SessionRunning = "session.running"` - `WorkspaceID string` - `type BetaWebhookSessionIdledEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionIdled` - `const SessionIdledSessionIdled SessionIdled = "session.idled"` - `WorkspaceID string` - `type BetaWebhookSessionRequiresActionEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionRequiresAction` - `const SessionRequiresActionSessionRequiresAction SessionRequiresAction = "session.requires_action"` - `WorkspaceID string` - `type BetaWebhookSessionArchivedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionArchived` - `const SessionArchivedSessionArchived SessionArchived = "session.archived"` - `WorkspaceID string` - `type BetaWebhookSessionDeletedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionDeleted` - `const SessionDeletedSessionDeleted SessionDeleted = "session.deleted"` - `WorkspaceID string` - `type BetaWebhookSessionStatusRescheduledEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionStatusRescheduled` - `const SessionStatusRescheduledSessionStatusRescheduled SessionStatusRescheduled = "session.status_rescheduled"` - `WorkspaceID string` - `type BetaWebhookSessionStatusRunStartedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionStatusRunStarted` - `const SessionStatusRunStartedSessionStatusRunStarted SessionStatusRunStarted = "session.status_run_started"` - `WorkspaceID string` - `type BetaWebhookSessionStatusIdledEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionStatusIdled` - `const SessionStatusIdledSessionStatusIdled SessionStatusIdled = "session.status_idled"` - `WorkspaceID string` - `type BetaWebhookSessionStatusTerminatedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionStatusTerminated` - `const SessionStatusTerminatedSessionStatusTerminated SessionStatusTerminated = "session.status_terminated"` - `WorkspaceID string` - `type BetaWebhookSessionThreadCreatedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionThreadCreated` - `const SessionThreadCreatedSessionThreadCreated SessionThreadCreated = "session.thread_created"` - `WorkspaceID string` - `type BetaWebhookSessionThreadIdledEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionThreadIdled` - `const SessionThreadIdledSessionThreadIdled SessionThreadIdled = "session.thread_idled"` - `WorkspaceID string` - `type BetaWebhookSessionThreadTerminatedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionThreadTerminated` - `const SessionThreadTerminatedSessionThreadTerminated SessionThreadTerminated = "session.thread_terminated"` - `WorkspaceID string` - `type BetaWebhookSessionOutcomeEvaluationEndedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionOutcomeEvaluationEnded` - `const SessionOutcomeEvaluationEndedSessionOutcomeEvaluationEnded SessionOutcomeEvaluationEnded = "session.outcome_evaluation_ended"` - `WorkspaceID string` - `type BetaWebhookVaultCreatedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultCreated` - `const VaultCreatedVaultCreated VaultCreated = "vault.created"` - `WorkspaceID string` - `type BetaWebhookVaultArchivedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultArchived` - `const VaultArchivedVaultArchived VaultArchived = "vault.archived"` - `WorkspaceID string` - `type BetaWebhookVaultDeletedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultDeleted` - `const VaultDeletedVaultDeleted VaultDeleted = "vault.deleted"` - `WorkspaceID string` - `type BetaWebhookVaultCredentialCreatedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultCredentialCreated` - `const VaultCredentialCreatedVaultCredentialCreated VaultCredentialCreated = "vault_credential.created"` - `VaultID string` ID of the vault that owns this credential. - `WorkspaceID string` - `type BetaWebhookVaultCredentialArchivedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultCredentialArchived` - `const VaultCredentialArchivedVaultCredentialArchived VaultCredentialArchived = "vault_credential.archived"` - `VaultID string` ID of the vault that owns this credential. - `WorkspaceID string` - `type BetaWebhookVaultCredentialDeletedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultCredentialDeleted` - `const VaultCredentialDeletedVaultCredentialDeleted VaultCredentialDeleted = "vault_credential.deleted"` - `VaultID string` ID of the vault that owns this credential. - `WorkspaceID string` - `type BetaWebhookVaultCredentialRefreshFailedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultCredentialRefreshFailed` - `const VaultCredentialRefreshFailedVaultCredentialRefreshFailed VaultCredentialRefreshFailed = "vault_credential.refresh_failed"` - `VaultID string` ID of the vault that owns this credential. - `WorkspaceID string` - `Type Event` Object type. Always `event` for webhook payloads. - `const EventEvent Event = "event"` ### Beta Webhook Event Data - `type BetaWebhookEventDataUnion interface{…}` - `type BetaWebhookSessionCreatedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionCreated` - `const SessionCreatedSessionCreated SessionCreated = "session.created"` - `WorkspaceID string` - `type BetaWebhookSessionPendingEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionPending` - `const SessionPendingSessionPending SessionPending = "session.pending"` - `WorkspaceID string` - `type BetaWebhookSessionRunningEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionRunning` - `const SessionRunningSessionRunning SessionRunning = "session.running"` - `WorkspaceID string` - `type BetaWebhookSessionIdledEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionIdled` - `const SessionIdledSessionIdled SessionIdled = "session.idled"` - `WorkspaceID string` - `type BetaWebhookSessionRequiresActionEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionRequiresAction` - `const SessionRequiresActionSessionRequiresAction SessionRequiresAction = "session.requires_action"` - `WorkspaceID string` - `type BetaWebhookSessionArchivedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionArchived` - `const SessionArchivedSessionArchived SessionArchived = "session.archived"` - `WorkspaceID string` - `type BetaWebhookSessionDeletedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionDeleted` - `const SessionDeletedSessionDeleted SessionDeleted = "session.deleted"` - `WorkspaceID string` - `type BetaWebhookSessionStatusRescheduledEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionStatusRescheduled` - `const SessionStatusRescheduledSessionStatusRescheduled SessionStatusRescheduled = "session.status_rescheduled"` - `WorkspaceID string` - `type BetaWebhookSessionStatusRunStartedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionStatusRunStarted` - `const SessionStatusRunStartedSessionStatusRunStarted SessionStatusRunStarted = "session.status_run_started"` - `WorkspaceID string` - `type BetaWebhookSessionStatusIdledEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionStatusIdled` - `const SessionStatusIdledSessionStatusIdled SessionStatusIdled = "session.status_idled"` - `WorkspaceID string` - `type BetaWebhookSessionStatusTerminatedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionStatusTerminated` - `const SessionStatusTerminatedSessionStatusTerminated SessionStatusTerminated = "session.status_terminated"` - `WorkspaceID string` - `type BetaWebhookSessionThreadCreatedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionThreadCreated` - `const SessionThreadCreatedSessionThreadCreated SessionThreadCreated = "session.thread_created"` - `WorkspaceID string` - `type BetaWebhookSessionThreadIdledEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionThreadIdled` - `const SessionThreadIdledSessionThreadIdled SessionThreadIdled = "session.thread_idled"` - `WorkspaceID string` - `type BetaWebhookSessionThreadTerminatedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionThreadTerminated` - `const SessionThreadTerminatedSessionThreadTerminated SessionThreadTerminated = "session.thread_terminated"` - `WorkspaceID string` - `type BetaWebhookSessionOutcomeEvaluationEndedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionOutcomeEvaluationEnded` - `const SessionOutcomeEvaluationEndedSessionOutcomeEvaluationEnded SessionOutcomeEvaluationEnded = "session.outcome_evaluation_ended"` - `WorkspaceID string` - `type BetaWebhookVaultCreatedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultCreated` - `const VaultCreatedVaultCreated VaultCreated = "vault.created"` - `WorkspaceID string` - `type BetaWebhookVaultArchivedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultArchived` - `const VaultArchivedVaultArchived VaultArchived = "vault.archived"` - `WorkspaceID string` - `type BetaWebhookVaultDeletedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultDeleted` - `const VaultDeletedVaultDeleted VaultDeleted = "vault.deleted"` - `WorkspaceID string` - `type BetaWebhookVaultCredentialCreatedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultCredentialCreated` - `const VaultCredentialCreatedVaultCredentialCreated VaultCredentialCreated = "vault_credential.created"` - `VaultID string` ID of the vault that owns this credential. - `WorkspaceID string` - `type BetaWebhookVaultCredentialArchivedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultCredentialArchived` - `const VaultCredentialArchivedVaultCredentialArchived VaultCredentialArchived = "vault_credential.archived"` - `VaultID string` ID of the vault that owns this credential. - `WorkspaceID string` - `type BetaWebhookVaultCredentialDeletedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultCredentialDeleted` - `const VaultCredentialDeletedVaultCredentialDeleted VaultCredentialDeleted = "vault_credential.deleted"` - `VaultID string` ID of the vault that owns this credential. - `WorkspaceID string` - `type BetaWebhookVaultCredentialRefreshFailedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultCredentialRefreshFailed` - `const VaultCredentialRefreshFailedVaultCredentialRefreshFailed VaultCredentialRefreshFailed = "vault_credential.refresh_failed"` - `VaultID string` ID of the vault that owns this credential. - `WorkspaceID string` ### Beta Webhook Session Archived Event Data - `type BetaWebhookSessionArchivedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionArchived` - `const SessionArchivedSessionArchived SessionArchived = "session.archived"` - `WorkspaceID string` ### Beta Webhook Session Created Event Data - `type BetaWebhookSessionCreatedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionCreated` - `const SessionCreatedSessionCreated SessionCreated = "session.created"` - `WorkspaceID string` ### Beta Webhook Session Deleted Event Data - `type BetaWebhookSessionDeletedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionDeleted` - `const SessionDeletedSessionDeleted SessionDeleted = "session.deleted"` - `WorkspaceID string` ### Beta Webhook Session Idled Event Data - `type BetaWebhookSessionIdledEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionIdled` - `const SessionIdledSessionIdled SessionIdled = "session.idled"` - `WorkspaceID string` ### Beta Webhook Session Outcome Evaluation Ended Event Data - `type BetaWebhookSessionOutcomeEvaluationEndedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionOutcomeEvaluationEnded` - `const SessionOutcomeEvaluationEndedSessionOutcomeEvaluationEnded SessionOutcomeEvaluationEnded = "session.outcome_evaluation_ended"` - `WorkspaceID string` ### Beta Webhook Session Pending Event Data - `type BetaWebhookSessionPendingEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionPending` - `const SessionPendingSessionPending SessionPending = "session.pending"` - `WorkspaceID string` ### Beta Webhook Session Requires Action Event Data - `type BetaWebhookSessionRequiresActionEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionRequiresAction` - `const SessionRequiresActionSessionRequiresAction SessionRequiresAction = "session.requires_action"` - `WorkspaceID string` ### Beta Webhook Session Running Event Data - `type BetaWebhookSessionRunningEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionRunning` - `const SessionRunningSessionRunning SessionRunning = "session.running"` - `WorkspaceID string` ### Beta Webhook Session Status Idled Event Data - `type BetaWebhookSessionStatusIdledEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionStatusIdled` - `const SessionStatusIdledSessionStatusIdled SessionStatusIdled = "session.status_idled"` - `WorkspaceID string` ### Beta Webhook Session Status Rescheduled Event Data - `type BetaWebhookSessionStatusRescheduledEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionStatusRescheduled` - `const SessionStatusRescheduledSessionStatusRescheduled SessionStatusRescheduled = "session.status_rescheduled"` - `WorkspaceID string` ### Beta Webhook Session Status Run Started Event Data - `type BetaWebhookSessionStatusRunStartedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionStatusRunStarted` - `const SessionStatusRunStartedSessionStatusRunStarted SessionStatusRunStarted = "session.status_run_started"` - `WorkspaceID string` ### Beta Webhook Session Status Terminated Event Data - `type BetaWebhookSessionStatusTerminatedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionStatusTerminated` - `const SessionStatusTerminatedSessionStatusTerminated SessionStatusTerminated = "session.status_terminated"` - `WorkspaceID string` ### Beta Webhook Session Thread Created Event Data - `type BetaWebhookSessionThreadCreatedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionThreadCreated` - `const SessionThreadCreatedSessionThreadCreated SessionThreadCreated = "session.thread_created"` - `WorkspaceID string` ### Beta Webhook Session Thread Idled Event Data - `type BetaWebhookSessionThreadIdledEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionThreadIdled` - `const SessionThreadIdledSessionThreadIdled SessionThreadIdled = "session.thread_idled"` - `WorkspaceID string` ### Beta Webhook Session Thread Terminated Event Data - `type BetaWebhookSessionThreadTerminatedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionThreadTerminated` - `const SessionThreadTerminatedSessionThreadTerminated SessionThreadTerminated = "session.thread_terminated"` - `WorkspaceID string` ### Beta Webhook Vault Archived Event Data - `type BetaWebhookVaultArchivedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultArchived` - `const VaultArchivedVaultArchived VaultArchived = "vault.archived"` - `WorkspaceID string` ### Beta Webhook Vault Created Event Data - `type BetaWebhookVaultCreatedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultCreated` - `const VaultCreatedVaultCreated VaultCreated = "vault.created"` - `WorkspaceID string` ### Beta Webhook Vault Credential Archived Event Data - `type BetaWebhookVaultCredentialArchivedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultCredentialArchived` - `const VaultCredentialArchivedVaultCredentialArchived VaultCredentialArchived = "vault_credential.archived"` - `VaultID string` ID of the vault that owns this credential. - `WorkspaceID string` ### Beta Webhook Vault Credential Created Event Data - `type BetaWebhookVaultCredentialCreatedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultCredentialCreated` - `const VaultCredentialCreatedVaultCredentialCreated VaultCredentialCreated = "vault_credential.created"` - `VaultID string` ID of the vault that owns this credential. - `WorkspaceID string` ### Beta Webhook Vault Credential Deleted Event Data - `type BetaWebhookVaultCredentialDeletedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultCredentialDeleted` - `const VaultCredentialDeletedVaultCredentialDeleted VaultCredentialDeleted = "vault_credential.deleted"` - `VaultID string` ID of the vault that owns this credential. - `WorkspaceID string` ### Beta Webhook Vault Credential Refresh Failed Event Data - `type BetaWebhookVaultCredentialRefreshFailedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultCredentialRefreshFailed` - `const VaultCredentialRefreshFailedVaultCredentialRefreshFailed VaultCredentialRefreshFailed = "vault_credential.refresh_failed"` - `VaultID string` ID of the vault that owns this credential. - `WorkspaceID string` ### Beta Webhook Vault Deleted Event Data - `type BetaWebhookVaultDeletedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultDeleted` - `const VaultDeletedVaultDeleted VaultDeleted = "vault.deleted"` - `WorkspaceID string` ### Unwrap Webhook Event - `type UnwrapWebhookEvent struct{…}` - `ID string` Unique event identifier for idempotency. - `CreatedAt Time` RFC 3339 timestamp when the event occurred. - `Data BetaWebhookEventDataUnion` - `type BetaWebhookSessionCreatedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionCreated` - `const SessionCreatedSessionCreated SessionCreated = "session.created"` - `WorkspaceID string` - `type BetaWebhookSessionPendingEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionPending` - `const SessionPendingSessionPending SessionPending = "session.pending"` - `WorkspaceID string` - `type BetaWebhookSessionRunningEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionRunning` - `const SessionRunningSessionRunning SessionRunning = "session.running"` - `WorkspaceID string` - `type BetaWebhookSessionIdledEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionIdled` - `const SessionIdledSessionIdled SessionIdled = "session.idled"` - `WorkspaceID string` - `type BetaWebhookSessionRequiresActionEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionRequiresAction` - `const SessionRequiresActionSessionRequiresAction SessionRequiresAction = "session.requires_action"` - `WorkspaceID string` - `type BetaWebhookSessionArchivedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionArchived` - `const SessionArchivedSessionArchived SessionArchived = "session.archived"` - `WorkspaceID string` - `type BetaWebhookSessionDeletedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionDeleted` - `const SessionDeletedSessionDeleted SessionDeleted = "session.deleted"` - `WorkspaceID string` - `type BetaWebhookSessionStatusRescheduledEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionStatusRescheduled` - `const SessionStatusRescheduledSessionStatusRescheduled SessionStatusRescheduled = "session.status_rescheduled"` - `WorkspaceID string` - `type BetaWebhookSessionStatusRunStartedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionStatusRunStarted` - `const SessionStatusRunStartedSessionStatusRunStarted SessionStatusRunStarted = "session.status_run_started"` - `WorkspaceID string` - `type BetaWebhookSessionStatusIdledEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionStatusIdled` - `const SessionStatusIdledSessionStatusIdled SessionStatusIdled = "session.status_idled"` - `WorkspaceID string` - `type BetaWebhookSessionStatusTerminatedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionStatusTerminated` - `const SessionStatusTerminatedSessionStatusTerminated SessionStatusTerminated = "session.status_terminated"` - `WorkspaceID string` - `type BetaWebhookSessionThreadCreatedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionThreadCreated` - `const SessionThreadCreatedSessionThreadCreated SessionThreadCreated = "session.thread_created"` - `WorkspaceID string` - `type BetaWebhookSessionThreadIdledEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionThreadIdled` - `const SessionThreadIdledSessionThreadIdled SessionThreadIdled = "session.thread_idled"` - `WorkspaceID string` - `type BetaWebhookSessionThreadTerminatedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionThreadTerminated` - `const SessionThreadTerminatedSessionThreadTerminated SessionThreadTerminated = "session.thread_terminated"` - `WorkspaceID string` - `type BetaWebhookSessionOutcomeEvaluationEndedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type SessionOutcomeEvaluationEnded` - `const SessionOutcomeEvaluationEndedSessionOutcomeEvaluationEnded SessionOutcomeEvaluationEnded = "session.outcome_evaluation_ended"` - `WorkspaceID string` - `type BetaWebhookVaultCreatedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultCreated` - `const VaultCreatedVaultCreated VaultCreated = "vault.created"` - `WorkspaceID string` - `type BetaWebhookVaultArchivedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultArchived` - `const VaultArchivedVaultArchived VaultArchived = "vault.archived"` - `WorkspaceID string` - `type BetaWebhookVaultDeletedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultDeleted` - `const VaultDeletedVaultDeleted VaultDeleted = "vault.deleted"` - `WorkspaceID string` - `type BetaWebhookVaultCredentialCreatedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultCredentialCreated` - `const VaultCredentialCreatedVaultCredentialCreated VaultCredentialCreated = "vault_credential.created"` - `VaultID string` ID of the vault that owns this credential. - `WorkspaceID string` - `type BetaWebhookVaultCredentialArchivedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultCredentialArchived` - `const VaultCredentialArchivedVaultCredentialArchived VaultCredentialArchived = "vault_credential.archived"` - `VaultID string` ID of the vault that owns this credential. - `WorkspaceID string` - `type BetaWebhookVaultCredentialDeletedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultCredentialDeleted` - `const VaultCredentialDeletedVaultCredentialDeleted VaultCredentialDeleted = "vault_credential.deleted"` - `VaultID string` ID of the vault that owns this credential. - `WorkspaceID string` - `type BetaWebhookVaultCredentialRefreshFailedEventData struct{…}` - `ID string` ID of the resource that triggered the event. - `OrganizationID string` - `Type VaultCredentialRefreshFailed` - `const VaultCredentialRefreshFailedVaultCredentialRefreshFailed VaultCredentialRefreshFailed = "vault_credential.refresh_failed"` - `VaultID string` ID of the vault that owns this credential. - `WorkspaceID string` - `Type Event` Object type. Always `event` for webhook payloads. - `const EventEvent Event = "event"`